SendSms
This endpoint allows sending of an sms message to the sim.
Network Support
| Network | NetworkId |
|---|---|
| eSIMsmart | 218 |
| eSIMsmart IOT | 225 |
| MT-IOT M2MO | 232 |
| MT-IOT M2MV | 233 |
| Vodafone GDSP | 240 |
- SIM status must be "on-hire"
- All SIMs must be:
- On the same network
- On the same account
Request
| Name | Type | Description | Restrictions |
|---|---|---|---|
serialNumbers | string array | An array of serial numbers corresponding to the SIMs you wish to update | At least one |
message | string | The message to send. Max 160 characters | |
binary | bool | Should the message be sent in binary format | |
protocolId | int | 0 - 255 | binary = true Not supported on Vodafone GDSP |
dataCodingScheme | int | 0 - 255 | binary = true Not supported on Vodafone GDSP |
userDataHeader | string | Hex format | binary = true Not supported on Vodafone GDSP |
Example SendSms
curl --location 'https://api.cellhire.com/api/simSubmission/SendSms' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
"serialNumbers": [
"987654321"
],
"message": "test message",
"binary": false
}'Binary SendSms Example
curl --location 'https://api.cellhire.com/api/simSubmission/SendSms' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjRBMDlENTFBMDhEOEUxMTU0OTkyODFDN...' \
--data '{
"serialNumbers": [
"987654321"
],
"message": "48656C6C6F2C20746869732069732061207465737420534D53",
"binary": true,
"protocolId": 7,
"dataCodingScheme": 8,
"userDataHeader": "0x05"
}'Successful Response
| Name | Type | Description |
|---|---|---|
ticketNumber | guid | Submission Id that has been created |
{ "ticketNumber": "1beeb8dd-1825-4bcd-8a62-f941aacb8d15" }