EsimQuery
i_accountstringYour account/subscriber's unique ID
Example: 12345Default:mpnstringEnter any of your SIM's numbers, mobile or landline, in e164 (i.e 44777...)
Example: 447777777777Default:iccidstringYour 19 digit SIM ID
Example: 8944444444444444444Default:refresh_codeinteger · enumIf set to 1 will refresh the activation code if eSIM has not yet been installed
Enum values:01Example: 1Default: 0
ResellerProvisionAccount
mpnstring · requiredNumber to be used as the account's primary mobile number (used for SMS, iMessage, etc)
Example: 447777777777
iccidstring19 digit ICCID of physical SIM (remove the final digit from printed version). If ICCID is not supplied the next available eSIM will be used.
Example: 8944530000000012345pbx_userstringAccount's SIP address/username - if not included in request it will default to 'ONSIM[ICCID]'
Example: USER12345pbx_passwordstringAccount's new SIP password - if not included in request we will create one and return this in the response
Example: 1a2B3c4D
ResellerProvisionAccountOnsim
mpnstring · requiredNumber to be used as the account's primary mobile number (used for SMS, iMessage, etc)
Example: 447777777777group_namestring · requiredCustomer Group ID
Example: CUSTOMER_Ahome_locationstring · enum · requiredHome Location of USER (GBR, USA, FRA, etc)
Enum values:GBRUSAFRAExample: USAfirst_namestring · requiredAccount's First Name
Example: Johnlast_namestring · requiredAccount's Last Name
Example: Smithemailstring · requiredAccount's Email Address
Example: j.smith@example.comproductinteger · requiredID of the product to provision
Example: 18mobile_datastring · enum · requiredData Bundle to be applied to the subscriber
Enum values:BACKGROUND-ONLY2GB4GB10GB20GBUNLIMITEDExample: 2GB
iccidstring19 digit ICCID of physical SIM (remove the final digit from printed version). If ICCID is not supplied the next available eSIM will be used.
Example: 8944530000000012345
SmsTerminate
idstring · requiredYour unique reference for the SMS Message
Example: 39edf9a4-7e2d-4126-af69-5246da735278Default:fromstring · required+e164 number of sender (i.e +44777...)
Example: +447777777777Default:tostring · required+e164 number of ONSIM Subscriber (i.e +44777...)
Example: +447888888888Default:messagestring · requiredBody of SMS encoded in UTF-8
Example: Hello ONSIM Subscriber!Default: