Skip to content

Send an SMS to eSIM

POST
/esims/{iccid}/sms

SMS must be GSM-7 bit compliant; with a minimum length of 1, and maximum length of 160 characters.

This defaults to eSIM and is the only supported value by default.

Unique identifiers can be assigned to your Organisation on request. Please contact your Account Manager to discuss this.

Note: Requires the eSIM to have an MSISDN

Authorizations

Parameters

Path Parameters

iccid
required
string

The ICCID of the eSIM

Request Body required

SMS message

object
message

GSM-7 bit compliant message

string
default: message >= 1 characters <= 160 characters
from

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.

string
default: eSIM

Responses

200

Message sent

object
message

Status of api functions which do not return data

string

400

Bad Request - returned when request format is not accepted

object
message

Status of api functions which do not return data

string

403

Unauthorised - returned when the api token is invalid or the user does not have permission to query the given ICCID

object
message

Status of api functions which do not return data

string

500

Server Error

object
message

Status of api functions which do not return data

string