SMS Verify API - Callback Service

This page describes any parameters in callback notifications from SMS Verify that are different from the general callback notification schema explained on Transaction Callback Service.

Schema

The SMS Verify callback notification schema includes both the parameters below and those described in the general schema:

📘

NOTE:

The sub-properties of additional_info are only included if the optional features they refer to are enabled for your account by TeleSign. If no optional features are enabled, the package does not appear.

PropertyTypeDescriptionExampleValidations
verifyobjectContains properties related to the status of a verification transaction.
verify.code_statestringIndicates whether the verification code you provided in your request matches that sent by TeleSign to the end-user. At this point in the verification process, the status is always UNKNOWN.Enum: UNKNOWN
verify.code_enterednull or stringIn some cases, this is the code entered by the end user. Usually the end user's code is not returned, and the value is empty string or null.null
sub_resourcestringThe subresource in the URI path that you made this request to.sms
additional_infoobjectAn optional package containing properties with further details about the messaging transaction. The message_parts_count and message_parts_reference_ids properties only appear if the message-split feature is enabled for your account. Contact our Customer Support Team to request this feature.
additional_info.message_parts_countintegerThe total number of split parts for the longer message. If the message is not split, this value is 1.1
additional_info.pricestringThe price from the operator for this transaction.0.5112
additional_info.mncstringThe mobile network code of the destination operator. See https://en.wikipedia.org/wiki/Mobile_country_code.03
additional_info.mccstringThe mobile country code of the destination operator. See https://en.wikipedia.org/wiki/Mobile_country_code.220
additional_info.currencystringThe currency type that applies to price.USD
additional_info.message_parts_reference_idsstringThe reference IDs for each part of the longer message, separated by commas.35E63E88CB000E049196AD1CFCFFB89C,35E63E88CC7C050491613443467F3F12

Example

Product-specific parameters that are not part of the general schema are highlighted in the code.

Example Callback Notification

POST /callback_endpoint HTTP/1.1
Host: your-callback-url.com
{ 
  "status": { 
     "updated_on": "2016-07-08T20:52:46.417428Z", 
     "code": 200, 
     "description": "Delivered to handset" 
   }, 
   "submit_timestamp": "2016-07-08T20:52:41.203000Z", 
   "errors": [], 
   "reference_id": "2557312299CC1304904080F4BE17BFB4",
   "verify": { 
     "code_state": "UNKNOWN", 
     "code_entered": null 
   }, 
   "sub_resource": "sms", 
   "additional_info": {
    "message_parts_count": 1,
    "price": "0.5112",
    "mnc": "03",
    "mcc": "220",
    "currency": "USD"
  }
}

Did this page help you?