Routes

GET

/routes

Este endpoint retorna a lista de rotas de envio disponíveis para o cliente autenticado. As rotas representam os canais e produtos de comunicação contratados e contêm informações como nome, tipo de produto, e valores de tarifação para envio e resposta.

Este recurso é útil para verificar quais rotas estão ativas e qual delas deve ser utilizada no momento de enviar uma mensagem via API.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/routes' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Response Example

{
    "hasError": true,
    "message": "string",
    "totalRecords": 0,
    "errors": [
        "string"
    ],
    "object": [
        {
            "id": 0,
            "displayName": "string",
            "farePrice": 0,
            "productName": "string",
            "productId": 0,
            "replyFarePrice": 0
        }
    ]
}

Modified at 2025-11-06 13:47:00

List

Received Messages Report