Start SMS Callback

Start SMS Callback:
PUT /sms/{accountName}/startCallbacks

Tells the ThingSpace Platform to start sending mobile-originated SMS messages through the EnhancedConnectivityService callback service. SMS messages from devices are queued until they are retrieved by your application, either by callback or synchronously with GET /sms/{accountName}/history.

Contents

See also:
Retrieve SMS Messages Sent by Devices
Send SMS Messages to Devices

SMS Message Handling

Mobile-originated SMS messages from devices are stored in a queue in the ThingSpace Platform if they cannot be delivered to your application immediately via the EnhancedConnectivityService callback. When your application sends a GET /sms request, the ThingSpace Platform sends queued messages. To ensure that messages are not lost, they remain in the queue until your application explicitly acknowledges that they were received by sending another request that contains the Token value from the response.

Here is the general flow for mobile-originated SMS messages:

  1. Mobile-Originated SMS message is sent by a device to 750075007500 or to 900060005010 and is received by ThingSpace.
  2. ThingSpace attempts to deliver the message via the DeviceMessages callback.
  3. If delivery fails, ThingSpace stores the message in a queue.
  4. Another mobile-originated SMS is sent by a device.
  5. ThingSpace attempts to deliver the new message via the callback.
  6. If delivery again fails, the message is stored in the queue.
  7. If your application sends a GET /sms request, any queued messages are sent in a synchronous response. If your application sends a PUT /sms/{accountName}/startcallbacks request, any queued messages are sent to the registered EnhancedConnectivityService callback URL.

When your EnhancedConnectivityService callback listener is working, new SMS messages received from devices will be sent as soon as they are received by ThingSpace. Any queued messages are not sent automatically; you must use PUT /sms/{accountName}/startcallbacks or GET /sms to retrieve those messages from the queue.

The SMS messages may be received out of order, relative to the order in which they were sent.

Request Components

HTTP Request

PUT https://thingspace.verizon.com/api/m2m/v1/sms/{accountName}/startCallbacks

Resource Path and Query Parameters

You must include the account name in the path.

Parameter Name Data Type Description
accountName
required
string The name of the billing account for which you want to start the SMS callback service. An account name is usually numeric, and must include any leading zeros.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization bearer token.
VZ-M2M-Token
required
string A valid session token returned by POST /session/login.
Content-Type
required
string Must be application/json.

Request Body

None.

Success Responses

Status 200

Parameter Name Data Type Description
success string A value of “true” indicates that the request was received.

Example Success Response

{
  "success": true
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!