Consultar saldo

A operação de consulta de saldo permite obter a informação do saldo actual de uma ou mais organizações, para cada um dos canais disponíveis (e.g. Email, SMS)

Parametrização

A operação permite obter o saldo actual para várias organizações em simultâneo, através da parametrização do campo organizationIds, um array de identificadores de organização - Número máximo de 50 Organizações

Exemplo:

{
  "organizationIds": ["06137abe-9556-4f9e-8a45-1880ba36a761"]
}

Resposta

A resposta contém um array balances, onde cada item contém os seguintes campos:

• organizationId – Identificador da organização
• channels – Quantidades de saldo para cada canal (e.g. Email, SMS). No caso do SMS, é retornada a quantidade de SMS disponível por cada país de destino de tráfego contratado pela organização
• error - Indica um erro ocorrido na obtenção do saldo da organização. Consultar mais informação neste link

Exemplo:

{
  "balances": [
    {
      "organizationId": "06137abe-9556-4f9e-8a45-1880ba36a76c",
      "channels": {
        "email": {
          "values": [
            {
              "balance": 950
            }
          ]
        },
        "sms": {
          "values": [
            {
              "countryId": "MZ",
              "balance": 1000
            },
            {
              "countryId": "PT",
              "balance": 24742
            },
            {
              "countryId": "RoW",
              "balance": 99913
            }
          ]
        }
      },
      "error": null
    }
  ],
  "error": {
    "code": null,
    "param": null,
    "description": null
  }
}

Erros

Em situações de erro, a propriedade error dentro de cada item do array balances (na resposta) será populada com um objeto que contém informações sobre o erro ocorrido:

"error": 
{   
    "code": "ORGANIZATION_BALANCE_CONFIG_NOT_FOUND",
    "param": "06137abe-9556-4f9e-8a45-1880ba36a761",
    "description": "ORGANIZATION_BALANCE_CONFIG_NOT_FOUND"
}

A propriedade code especifica que tipo de erro ocorreu. A lista completa de códigos de erro pode ser consultada neste link

Aceder à API Reference