Step 3: Query the status of a sent SMS / message notification

The tyntec server will respond to your query with the current message notification. tyntec stores message notifications for three months. tyntec will also POST these message notifications in case there is a call-back URL specified.

Query the status of a request / Message Notification (JSON)

curl https://username:password@rest.tyntec.com/sms/v1/outbound/requests/status/12-75cfafba-8799-4f2b-8505-ece6af6abf01

Message Notification (JSON)

{

 "requestId":"12-75cfafba-8799-4f2b-8505-ece6af6abf01",
 "overallState":"DELIVERED",
 "size":"1",
 "from":"+4915112345678",
 "to":"+4917912345678",
 "userContext":"testmessage1",
 "mccmnc":"26207",
 "ttid":"16",
 "overallPrice":"0.55",
 "contentList":
  [{
   "deliveryState":"DELIVERED",
   "statusText":"This is a test.",
   "msgId":"12-1407778865439+1234567890",
   "price":"0.55",
   "currency":"EUR",
   "priceEffective":"2014-12-24T18:30:00+01:00",
   "sentDate":"2014-05-13T17:41:06+01:00",
   "doneDate":"2014-05-13T17:41:07+01:00",    
   "errorCode":"001"
  }]
}
 
Message Notification (XML)

 12-75cfafba-8799-4f2b-8505-ece6af6abf01
 DELIVERED
 1
 +4915112345678
 +4917912345678
 testmessage1
 26207
 16
 0.55
 
  
   DELIVERED
   This is a test.
   12-1407778865439+1234567890
   0.55
   EUR
   2014-12-24T18:30:00+01:00
   2014-05-13T17:41:06+01:00
   2014-05-13T17:41:07+01:00          
   001
  
 

Parameter

Description

requestId

The unique identifier provided for each request.

overallState

Aggregated status from all respective delivery status.

size

The amount of respective concatenated SMS parts.

from

This parameter gives the identification of the sending party, which can either be the phone number in international format or an alphanumeric identifier with up to 11 characters*.

to

*Some destination networks impose restrictions on the sender ID format. Please check the coverage list and/or contact your account manager for more information.

 This parameter represents the receiving party’s phone number in international format.

userContext

The custom message context provided by the customer.

mccmnc

A representative IMSI prefix of the target network. The respective mapping can be found at http://mcc-mnc.com/, for example.

ttid

The respective tyntec ID of the target network. 

overallPrice

Aggregated price from all respective message parts.

MessageNotificationContent

The actual message notifications for respective parts.

message

Separator for each part.

deliveryState

The delivery status of this specific part. Possible values are given in a following table.

statusText

The first 20 characters of the sent message.

msgId

The unique identifier provided for each message.

price

The price for sending the respective message part.

currency

The currency in which the price is given; corresponding to the currency of the invoice.

priceEffective

The date when the “price” became active.

sentDate

The time stamp when the message was sent out by tyntec for delivery.

doneDate

The time stamp when the message was successfully delivered.

errorCode

The reason for an unsuccessful delivery attempt. Possible values are given in a following table.


Possible values for “deliveryStatus”:

Delivery Status

Description

DELIVERED

Message was successfully delivered.

UNDELIVERABLE

Message cannot be delivered. See error codes for more details.

EXPIRED

Message expired, i.e., the message could not be delivered within the specified time span. See error codes for more details.

REJECTED

Message rejected, i.e., the message could not be accepted by our platform. See error codes for more details.

BUFFERED

Message could not be delivered. tyntec is in the process of resending. Please wait for one of the above final statuses.


Possible values for “errorCode” without GSM-error-code account-feature active (default):

Code

Description

001

Message was successfully delivered.

002

Message cannot be delivered.

006

Message expired, i.e., the message could not be delivered within the specified time span.

010

Message rejected, i.e., the message could not be delivered by our platform.

011

Message could not be delivered. tyntec is in the process of resending. Please wait for one of the above final statuses.

013

Same as 010.

020

Same as 010.


Possible values for “errorCode” with GSM error code can be found in the document “GSM Error Codes” (additional feature on request).