HTTPS API v2 / RCS support verification

Calling address

In order to check number using the Remote Service, you must send a specific application via HTTP or HTTPS using the POST method.

phones/rcs

Available parameters

Parameter Type Sample value or format Description
username String login Login to the account.
password String haslo Password to the account.
rcs_id String ID RCS for example: 54c53be2-cbb8-11ec-9d64-0242ac120002 The ID is available in our panel, assigned to each BOT configuration created.
phone String +48500600700 A number or array of phone numbers.
details Boolean true, false or empty A parameter that displays additional details in the response, including information about the network and functionalities.

Parameters marked in bold are mandatory. The rest are optional.

The return generated after submitting a sample single query with details = 1.

{
   "items":[{
         "phone":"+48500600700",
         "result":"RCS_OK",
         "details":{"capabilities":["chatBotCommunication"],"network":"Orange (PTK Centertel Sp. z o.o.)", "network_code": "26003"}
   }]
}

Explanation of individual feedback parameters

Parametr Opis
phone

Phone number checked

result

Check result:

CHECK_ERR - problem with number verification.

RCS_OK - correct value, the number supports RCS messages.

RCS_ERR - the number does not support RCS messages.

NETWORK_ERR - invalid network.

details

capabilities - an array specifying the functionalities supported by the recipient

network - network name of the verified number

network_code - network code of the verified number

Recommended settings

Do not submit more than 10 numbers in one query.