Transferir SMS

A operação de transferência de saldo SMS permite transferir saldo do canal SMS entre duas organizações.

A quantia de saldo especificada é retirada de uma organização source e adicionada a uma organização destination.

Parametrização

A operação permite especificar os seguintes campos:

• sourceOrganizationId - Identificador da organização de onde o saldo será retirado
• destinationOrganizationId - Identificador da organização onde o saldo será adicionado
• amount - Quantia de saldo a transferir entre as duas organizações
• countryId - Código do país do tráfego de SMS a transferir. Este código deve seguir o formato ISO 3166-1 alpha-2. Em adição aos países estabelecidos na norma, é possível também especificar o destino RoW, que representa um contador de saldo para um país não especificado. As organizações intervenientes devem ter este destino previamente contratado, de forma a que seja elegível nas operações de transferência de saldo.
• reason - Campo de texto livre descritivo

Exemplo:

{
  "sourceOrganizationId":"2ebcea9a-a354-4ef3-b240-69bd56043ace",
  "destinationOrganizationId":"55f06978-2ba9-4e61-842b-3c1d33022173",
  "amount":"1000",
  "reason":"Fulfilling sales department request",
  "countryId": "PT"
}

Resposta

A resposta retornará informação sobre o saldo actual das organizações intervenientes. A resposta contém um objecto transferResult, contendo os seguintes campos

• sourceOrganization – Informação de saldo actual da organização source
• destinationOrganization – Informação de saldo actual da organização destination

Exemplo:

{
  "transferResult": {
    "sourceOrganization": {
      "organizationId": "2ebcea9a-a354-4ef3-b240-69bd56043ace",
      "channels": {
        "email": {
          "values": [
            {
              "balance": 1588
            }
          ]
        },
        "sms": {
          "values": [
            {
              "countryId": "PT",
              "balance": 88
            },
            {
              "countryId": "RoW",
              "balance": 78
            }
          ]
        }
      },
      "error": null
    },
    "destinationOrganization": {
      "organizationId": "55f06978-2ba9-4e61-842b-3c1d33022173",
      "channels": {
        "email": {
          "values": [
            {
              "balance": 69
            }
          ]
        },
        "sms": {
          "values": [
            {
              "countryId": "PT",
              "balance": 9
            },
            {
              "countryId": "RoW",
              "balance": 97545
            }
          ]
        }
      },
      "error": null
    }
  },
  "error": {
    "code": null,
    "param": null,
    "description": null
  }
}

Erros

Em situações de erro, a propriedade errorCode especifica que tipo de erro ocorreu. A lista completa de códigos de erro pode ser consultada neste link

Aceder à API Reference