API v2.4 / eSIMs / Send SMS to eSIM
POST /esims/{iccid}/sms
Send an SMS message to a specific eSIM. Key points:
- Message requirements:
- UTF-8 compliant
- Length: 1-160 characters
- Default recipient: ‘eSIM’ (currently the only supported value)
- Custom identifiers available upon request (contact Account Manager)
Note: For custom identifiers, please contact your Account Manager.
Authorizations
Parameters
Path Parameters
(Required) The ICCID of the eSIM
Example
8944123456789012000Request Body
object
UTF-8 compliant message
Name of sender that will show in SMS.
This defaults to eSIM and is the only supported value by default. Unique identifiers can be assigned to your Organisation on request.
{ "message": "Hello!", "from": "eSIM"}Responses
200
OK
object
Status message of api request
Example
{ "status": "sent"}400
Bad Request - returned when request format is not accepted
object
Status of api functions which do not return data
403
Unauthorised - returned when the api token is invalid; the user does not have any available Bundles left or the ICCID is not accessible by the user
object
Status of api functions which do not return data
429
Too Many Requests
object
Status of api functions which do not return data
500
Server Error
object
Status of api functions which do not return data
503
Processing - Please come back later or use the Retry-After (seconds) header
object
Status of api functions which do not return data