Test Requests

Request a test

Intro

When you request a test, Texter will check if it has an online test node available.
Texter will respond with test details if there is an online test node available for testing.
But if Texter doesn’t have a test node available, or doesn't support the operator you want to test, the test details will be empty.

The test details will contain a message key that remains valid for 1 test message via 1 supplier for the given MSISDN .
If you send multiple test messages with that same key (also via multiple suppliers), you will not get the result details of those messages.

The MSISDN will be given in the international E.164 notation with leading zeroes as number prefix by default.

The number prefix can be changed in the Texter app to one of the following options:

  • Leading zeroes (default)
  • Plus
  • No leading zeroes

Single test request

Request a single test at Texter.

If you want to perform multiple tests right after eachother, we recommend to use the multi test requests call.

Request

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

Request body

FieldRequiredTypeDescription
mccMncyesstringOperator you want to test.
testDurationnointegerTest duration in minutes until Texter expires the test with no delivered result (min = 1, max = 60, default = 5).
portabilityStatusnointegerPortability status that the test node must have (0 = Ignore, 1 = Non ported, 2 = Ported, default = 0).
resultApiUrlnostringCallback URL which receives the result reports. If this is not given, then Texter will use the general callback URL if configured in the Texter app.
{
  "mccMnc": "20416",
  "testDuration": 5,
  "portabilityStatus": 0,
  "resultApiUrl": "https://cm.com/callback"
}

Response

FieldTypeDescription
detailsstringStatus message of the requested test (Operator not supported, No candidate available, Found an available candidate).
mccMncstringRequested operator.
requestedPortabilityStatusintegerRequested portability status.
testobjectTest information, is null if no online test node could be found. (See below)

Test:

FieldTypeDescription
idstringCode identifier of your test.
msisdnstringPhone number of test node.
isMsisdnNetworkPortedboolIs the MSISDN a ported number, can be null if the status is unknown.
messageKeystringSet of 16 characters that must be in your text message.
preferredAlphaNumericSenderstringAlphanumeric sender suggestion to use in your text message.
preferredNumericSenderstringNumeric sender suggestion to use in your text message.
{
  "details": "Found an available candidate",
  "mccMnc": "20416",
  "requestedPortabilityStatus": 0,
  "test": {
    "id": "20a82d0c-60f7-4895-9eec-8438dcebcf38",
    "msisdn": "0031611223344",
    "isMsisdnNetworkPorted": false,
    "messageKey": "atchint umge din",
    "preferredAlphaNumericSender": "abisizoldel",
    "preferredNumericSender": "00778279878279"
  }
}

Multi test requests

You can request multiple Texter tests for a batch of operators you want to test.
Operators can be included multiple times in the batch if you want to send multiple tests for the same operator.

Request

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

Request body

FieldRequiredTypeDescription
mccMncyesstringOperator you want to test.
testDurationnointegerTest duration in minutes until Texter expires the test with no delivered result (min = 1, max = 60, default = 5).
portabilityStatusnointegerPortability status that the test node must have (0 = Ignore, 1 = Non ported, 2 = Ported, default = 0).
resultApiUrlnostringCallback URL which receives the result reports. If this is not given, then Texter will use the general callback URL if configured in the Texter app.
[
  {
    "mccMnc": "20416",
    "testDuration": 5,
    "portabilityStatus": 0,
    "resultApiUrl": "https://cm.com/callback"
  },
  {
    "mccMnc": "20400",
    "testDuration": 3,
    "portabilityStatus": 1,
    "resultApiUrl": "https://cm.com/callback"
  },
  {
    "mccMnc": "20416",
    "testDuration": 5,
    "portabilityStatus": 2,
    "resultApiUrl": "https://cm.com/callback"
  }
]

Response

FieldTypeDescription
detailsstringStatus message of the requested test (Operator not supported, No candidate available, Found an available candidate).
mccMncstringRequested operator.
requestedPortabilityStatusintegerRequested portability status.
testobjectTest information, is null if no online test node could be found. (See below)

Test:

FieldTypeDescription
idstringCode identifier of your test.
msisdnstringPhone number of test node.
isMsisdnNetworkPortedboolIs the MSISDN a ported number, can be null if the status is unknown.
messageKeystringSet of 16 characters that must be in your text message.
preferredAlphaNumericSenderstringAlphanumeric sender suggestion to use in your text message.
preferredNumericSenderstringNumeric sender suggestion to use in your text message.
[
  {
    "details": "Found an available candidate",
    "mccMnc": "20416",
    "requestedPortabilityStatus": 0,
    "test": {
      "id": "20a82d0c-60f7-4895-9eec-8438dcebcf38",
      "msisdn": "0031611223344",
      "isMsisdnNetworkPorted": false,
      "messageKey": "atchint umge din",
      "preferredAlphaNumericSender": "abisizoldel",
      "preferredNumericSender": "00778279878279"
    }
  },
  {
    "details": "Operator not supported",
    "mccMnc": "20400",
    "requestedPortabilityStatus": 0,
    "test": null
  },
  {
    "details": "Found an available candidate",
    "mccMnc": "20416",
    "requestedPortabilityStatus": 2,
    "test": {
      "id": "388BA892-6C20-4977-9585-E58F9CD49DB8",
      "msisdn": "0031655667788",
      "isMsisdnNetworkPorted": true,
      "messageKey": "ste whomeblughte",
      "preferredAlphaNumericSender": "lindopeabip",
      "preferredNumericSender": "00105580205580"
    }
  }
]

Did this page help you?