Get transaction status

Get delivery status and other details for a Telesign SMS Verify API transaction that you have created. Use this endpoint also to complete verification, if Telesign generated your code.

General requirements

  • Authentication: Basic (easiest to implement) or Digest
  • Encoding: Accepts only UTF-8 unicode characters as inputs.
  • Accepts: application/x-www-form-urlencoded
  • Required headers: Content-Type - application/x-www-form-urlencoded
  • Rate limit: Default rate limits by product
Path Params
string
required
Query Params
string

If Telesign generated the code sent to your end user, include the asserted verification code from your end user here.

Responses

status.code and errors.code properties in the response payload, rather than the HTTP status code of the response.

Status codeAssociated text stringDescription
200Delivered to handsetThe SMS was delivered to the end user's phone. (Final)
203Delivered to gatewayThe SMS was delivered to the gateway. If the gateway responds with further information (including successful delivery to handset or delivery failure), the status is updated. (Intermediate)
207Error delivering SMS to handset (reason unknown)The SMS could not be delivered to the end user's handset for an unknown reason. (Final)
210Temporary phone errorThe SMS could not be delivered to the handset due to a temporary error with the phone. Examples - phone is turned off, not enough memory to store the message. (Final)
211Permanent phone errorThe SMS could not be delivered to the handset due to a permanent error with the phone. For example, the phone is incompatible with SMS, or illegally registered on the network. This can happen when a phone number is blacklisted, or is incorrectly provisioned. (Final)
220Gateway/network cannot route messageThe network cannot route the message to the handset. (Final)
221Message expired before deliveryThe message was queued by the mobile provider and timed out before it could be delivered to the handset. (Final)
222SMS not supportedSMS is not supported by this phone, carrier, plan, or user.
229Message blocked by customer requestTelesign blocked the SMS before it was sent. This is due to your prior submitted request to blocklist this phone number.
230Message blocked by TelesignTelesign blocks a message if it is being sent to a phone number that is on a global blocklist.
231Invalid/unsupportedInvalid/unsupported message content.
233Message blocked due to high risk score.It was determined that the risk score for the destination number is higher than configured Maximum Risk Score. For that reason Telesign did not send the SMS.
237Message blocked in requested countryYou requested that messages in a specific country be blocked, and the message was being sent to this country.
250Final status unknownThe final status of the SMS cannot be determined.
251Message successfully sent out for delivery, however final confirmation of delivery to handset was not received.Telesign successfully delivered the message through our gateway and it passed downstream. However, Telesign did not receive a delivery receipt within 12 hours of transmission. We cannot confirm delivery to the handset. The end user most likely did not receive the message.
290Message in progressThe message is being sent to the SMS gateway.
292Queued by gatewayThe SMS gateway has queued the message.
295Status delayedThe status of the SMS is temporarily unavailable.
500Transaction not attemptedNo SMS request was attempted.
501Not authorizedNo permissions for this resource, or authorization failed.
502Campaign errorThis error can be generated if there is a problem with the short code used.
503Carrier rejected - temporary problemThis error is generated if there is an error on the carrier or operator side that is temporary and the message can be retried.
504Carrier rejected - permanent errorThis error is generated if there is an error on the carrier or operator side that is permanent and the message should not be retried.
505Error on gateway - temporary errorThis error is generated if there is an error on Telesign's partner side that is considered temporary and the message can be retried.
506Error on gateway - permanent errorThis error is generated if there is an error on Telesign's partner side that is considered permanent and the message should not be retried.
507Invalid destination addressThere is a problem with the destination address used. Either the format is not valid, or the number is not associated with any carrier, or if MSC is used it does not know about this MSISDN.
508Invalid source addressThe message requires a source address. Verify that one is provided and correct.
509Parameters problemOne or more parameters used in the request is not supported.
510Message blocked by subscriber action or requestThe end user has blocked receiving SMS with their carrier plan or by request or from the particular short code used.
511Subscriber low on creditThe end user exceeded their spending limits and cannot receive SMS.
512Roaming errorEnd user cannot receive SMS because their device that receives the messages is roaming.
513Mobile number portability errorSMS failed because ported combinations are unreachable.
514Subscriber absentThe operator/carrier is temporarily unable to reach the end user.
515Suspected spamThis message is considered to be spam by carrier or operator.
517Selected DLT details for India not supportedThe DLT template ID or entity ID in the request cannot be found by the end operator.
518Message blocked due to high risk SIM SWAP indicatorThe service determined that the SIM swap risk indicator for the destination number is higher than the maximum value configured for your account. For that reason Telesign did not send the SMS.
519Message not sent - requested SIM SWAP check could not be performedThe service could not perform the SIM swap check. This is because either the number is out of SIM swap coverage or information about the potential SIM swap event is missing.
520Content sent is not allowedThe content in this message is not permitted by the carrier.
521Requested Sender ID is not allowed for destinationThe sender ID submitted in request is not allowed in destination country/operator.
599Status not availableThe system is unable to provide status at this time.

status.code and errors.code properties in the response payload, rather than the HTTP status code of the response.

Error CodeAssociated text string
-10001Invalid Request: ReferenceID Parameter: <reference_id>
-10001Invalid Request: CustomerID Parameter: <customer_id>
-10001Invalid Request: AuthenticationID
-10001Invalid Request: CustomerID/AuthenticationID Parameter: <customer_id>/<authentication_id>
-10001Invalid Request: customer_id Parameter: <customer_id>

Associated text string for -10001 will change depending on the parameter.

status.code and errors.code properties in the response payload, rather than the HTTP status code of the response.

Error CodeAssociated text string
-10001Not Allowed Host: Hostname Parameter: <parameter>
-10001Not Allowed Host: IP Parameter: <parameter>
-10009Invalid source IP address.
-20001Invalid Request: CustomerID Parameter: <customer_id>
-20002This product is not enabled for this Customer ID.
-30000Invalid Customer ID.
-30001Customer ID Account Suspended.
-30002Customer ID Account Not Activated.
-30003Customer ID new account limit reached.
-30004Missing required 'Authorization' header
-30005Required 'Authorization' header is not in the correct format
-30006Invalid Signature
-30007Missing required 'Date' or 'x-ts-date' header
-30008Invalid 'x-ts-auth-method' header.
-30009'Date' or 'x-ts-date' header is not RFC822 compliant
-30010'Date' or 'x-ts-date' header is not within tolerable range
-30011'x-ts-nonce' header value is either too long or too short
-30012'x-ts-nonce' header value has been used recently
-30015Invalid API Key.

status.code and errors.code properties in the response payload, rather than the HTTP status code of the response.

Error CodeAssociated text string
-10001CustomerID/ReferenceID not found
-10001CustomerID/ReferenceID not found: CustomerID/ReferenceID Parameter: <parameter>
-10004Reference ID expired.

Associated text string for -10001 will change depending on the parameter.

status.code and errors.code properties in the response payload, rather than the HTTP status code of the response.

Error CodeAssociated text string
-40007Rate Limit Exceeded
-40008<product> exceeded transaction hard cap. Request denied.

status.code and errors.code properties in the response payload, rather than the HTTP status code of the response.

Error CodeAssociated text string
-90001System Unavailable, please try again later.

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json