Test results

Status definitions

Code	Name	Description
0	Pending	The test result is still pending.
1	Finished	The test has finished with delivered results on the handset.
2	No result	The test has expired with no delivery results on the handset. However, should the message eventually be delivered within 24 hours, then the test will be updated to 'Finished' after all
3	Handset unreachable	Temporary status. Texter detected that the handset went offline during this test. This temporary status is only used in the callback report towars your callback URL.
4	Invalid test	The test has expired while the handset still was offline and has been invalidated. However, should the handset come online again within 24 hours, then the test will be updated to either 'Finished' or 'No result'
5	Rejected by supplier	Dashboard only status. Your chosen supplier has rejected your request of sending a text message.

Get single result

Poll the status of a single test with potential delivered results. Supply your test identifier in the URL to receive the current status, test details and test results.

Request

GET https://api.cmtelecom.com/texter/v1/testresult/{texterProductAccount}/{id}

Response

Field	Type	Description
id	string	Identifier of your test
requestDate	dateTime	UTC date and time when the test was requested
expirationDate	datetime	UTC date and time when the test will be considered not delivered
statusCode	integer	Status code of the test (see Status definitions)
status	string	Status description (see Status definitions)
mccMnc	string	Requested operator
msisdn	string	Phone number of the test node
isMsisdnNetworkPorted	boolean	Is the MSISDN a ported number, can be null if the status is unknown
messageKey	string	Message key of your test
result	object	Object containing result data from the handset, is null if nothing has been delivered

Result:

Field	Type	Description
sender	string	Received sender of your test message
content	string	Received content of your test message
phoneReceivedDateTime	dateTime	Date and time (UTC) when your test message was received on the test node
serviceCenter	string	Service center (SMSC) that lastly has been used for your delivered message
serviceCenterCountry	string	ISO country code of service center
syncedWithNTP	boolean	Is the received date and time of the test node synced with a NTP server
resultReceivedDateTime	dateTime	Date and time (UTC) when Texter received the test results from the test node with internet delay included
encoding	integer	The encoding with which the message was delivered to the phone, can be null
udh	string	User data header(s) (comma seperated) buried within the delivered message, can be null
pdu	string array	Multipart PDU of the delivered message, can be null

{
  "id": "dfa49097-4912-4ad2-b76f-9d59ac31fdf9",
  "requestDate": "2020-07-04T18:42:33.037Z",
  "statusCode": 1,
  "status": "Finished",
  "mccMnc": "20404",
  "msisdn": "0031611223344",
  "isMsisdnNetworkPorted": false,
  "messageKey": "uvamp umolle owi",
  "preferredAlphaNumericSender": "dendasalute",
  "preferredNumericSender": "00674182674182",
  "expirationDate": "2020-07-04T18:47:33.03Z",
  "result": {
    "sender": "dendasalute",
    "content": "uvamp umolle owi: }2<0(~e`ab&",
    "phoneReceivedDateTime": "2020-07-04T18:42:43.987Z",
    "serviceCenter": "+31686899908",
    "serviceCenterCountry": "NL",
    "syncedWithNtp": true,
    "resultReceivedDateTime": "2020-07-04T18:45:13.913Z",
    "encoding": 25,
    "udh": "0003010201,0003010202",
    "pdu": [
      "07911386869909F84014D0E4B29B1C9E87D9757A1900190270400"
    ]
  }
}

Get multiple results

Poll the status of multiple tests with potential delivered results. Supply your test identifiers in the request body to receive the current status, test details and test results.

Request

POST https://api.cmtelecom.com/texter/v1/testresult/{texterProductAccount}

Request body

Array of GUID identifiers

[
  "DFA49097-4912-4AD2-B76F-9D59AC31FDF9",
  "3E0BEBCD-92CB-497B-A884-C9E007C11E0A"
]

Response

Field	Type	Description
id	string	Identifier of your test
requestDate	dateTime	UTC date and time when the test was requested
expirationDate	datetime	UTC date and time when the test will be considered not delivered
statusCode	integer	Status code of the test (see Status definitions)
status	string	Status description (see Status definitions)
mccMnc	string	Requested operator
msisdn	string	Phone number of the test node
isMsisdnNetworkPorted	boolean	Is the MSISDN a ported number, can be null if the status is unknown
messageKey	string	Message key of your test
result	object	Object containing result data from the handset, is null if nothing has been delivered

Result:

Field	Type	Description
sender	string	Received sender of your test message
content	string	Received content of your test message
phoneReceivedDateTime	dateTime	Date and time (UTC) when your test message was received on the test node
serviceCenter	string	Service center (SMSC) that lastly has been used for your delivered message
serviceCenterCountry	string	ISO country code of service center
syncedWithNTP	boolean	Is the received date and time of the test node synced with an NTP server
resultReceivedDateTime	dateTime	Date and time (UTC) when Texter received the test results from the test node with internet delay included
encoding	integer	The encoding with which the message was delivered to the phone, can be null
udh	string	User data header(s) (comma seperated) buried within the delivered message, can be null
pdu	string array	Multipart PDU of the delivered message, can be null

[
  {
    "id": "dfa49097-4912-4ad2-b76f-9d59ac31fdf9",
    "requestDate": "2020-07-04T18:42:33.037Z",
    "statusCode": 1,
    "status": "Finished",
    "mccMnc": "20404",
    "msisdn": "0031611223344",
    "isMsisdnNetworkPorted": false,
    "messageKey": "uvamp umolle owi",
    "preferredAlphaNumericSender": "dendasalute",
    "preferredNumericSender": "00674182674182",
    "expirationDate": "2020-07-04T18:47:33.03Z",
    "result": {
      "sender": "dendasalute",
      "content": "uvamp umolle owi: }2<0(~e`ab&",
      "phoneReceivedDateTime": "2020-07-04T18:42:43.987Z",
      "serviceCenter": "+31686899908",
      "serviceCenterCountry": "NL",
      "syncedWithNtp": true,
      "resultReceivedDateTime": "2020-07-04T18:45:13.913Z",
      "encoding": 25,
      "udh": "0003010201,0003010202",
      "pdu": [
        "07911386869909F84014D0E4B29B1C9E87D9757A1900190270400"
      ]
    }
  },
  {
    "id": "3e0bebcd-92cb-497b-a884-c9e007c11e0a",
    "requestDate": "2020-07-14T10:16:10.72Z",
    "statusCode": 1,
    "status": "Finished",
    "mccMnc": "20416",
    "msisdn": "0031655667788",
    "isMsisdnNetworkPorted": true,
    "messageKey": "uzelle andukemoa",
    "preferredAlphaNumericSender": "traldospupe",
    "preferredNumericSender": "00559523759523",
    "expirationDate": "2020-07-14T10:21:10.737Z",
    "result": {
      "sender": "traldospupe",
      "content": "uzelle andukemoa: åù¿OÅc]31FC)?€;GøÉ|$?Z&<@+,Ü%~à:SÖñbò¥[?!?ÑÄ^¤>-èÇBö?{=Æ.0_¡æ#§ì2Ø?aäé/T(A}üß*£'",
      "phoneReceivedDateTime": "2020-07-14T10:16:12.803Z",
      "serviceCenter": "+31624000000",
      "serviceCenterCountry": "NL",
      "syncedWithNtp": true,
      "resultReceivedDateTime": "2020-07-14T10:16:13.653Z",
      "encoding": 0,
      "udh": null,
      "pdu": [
        "07911326040000F00414D07479984D7ECFE1757819000002704121"
      ]
    }
  }
]

Get results with filter options

You can poll a list of tests and results by using some additional filters. Optional parameters can be given to filter the Texter test results in the response.

By default, this API call will get your most recent test details

Request

GET https://api.cmtelecom.com/texter/v1/testresult/{productAccount}

Optional request parameters

Field	Type	Description
mccMnc	string	Operator filter
fromDate	dateTime	Get test results of tests initiated after this date and time
toDate	dateTime	Get test results of tests initiated before this date and time
amountOfResults	integer	Maximum amount of test results to include in the response (default = 100, max = 10000)

Callback report

Texter can automatically send results of your Texter tests to a specified callback URL specified either configured in the Texter app or set in your API request (ResultApiUrl parameter).
Your callback API must support a HTTP POST and respond with a status in the 200 range.

Request body

Field	Type	Description
id	string	Identifier of your test
statusCode	integer	Status code of the test (see Status definitions)
status	string	Status description (see Status definitions)
messageKey	string	Message key of your test
result	object	Object containing result data from the handset, is null if nothing has been delivered

Result:

Field	Type	Description
sender	string	Received sender of your test message
content	string	Received content of your test message
phoneReceivedDateTime	dateTime	Date and time (UTC) when your test message was received on the test node
msisdn	string	Phone number of the test node
isMsisdnNetworkPorted	boolean	Is the MSISDN a ported number, can be null if the status is unknown
serviceCenter	string	Service center (SMSC) that lastly has been used for your delivered message
serviceCenterCountry	string	ISO country code of service center
syncedWithNTP	boolean	Is the received date and time of the test node synced with a NTP server
resultReceivedDateTime	dateTime	Date and time (UTC) when Texter received the test results from the test node with internet delay included
encoding	integer	The encoding with which the message was delivered to the phone, can be null
udh	string	User data header(s) (comma seperated) buried within the delivered message, can be null
pdu	string array	Multipart PDU of the delivered message, can be null

{
  "id": "dfa49097-4912-4ad2-b76f-9d59ac31fdf9",
  "statusCode": 1,
  "status": "Finished",
  "messageKey": "uvamp umolle owi",
  "result": {
    "sender": "dendasalute",
    "content": "uvamp umolle owi: }2<0(~e`ab&",
    "phoneReceivedDateTime": "2020-07-04T18:42:43.987Z",
    "msisdn": "0031611223344",
    "isMsisdnNetworkPorted": false,
    "serviceCenter": "+31686899908",
    "serviceCenterCountry": "NL",
    "syncedWithNtp": true,
    "resultReceivedDateTime": "2020-07-04T18:45:13.913Z",
    "encoding": 25,
    "udh": "0003010201,0003010202",
    "pdu": [
      "07911386869909F84014D0E4B29B1C9E87D9757A1900190270400"
    ]
  }
}