NYSE: IDT
Mantenha-se à frente com a IDT Express
Produtos

Descubra como nossos produtos podem revolucionar a maneira como você se comunica e colabora.

voz

Explore nossas soluções de voz avançadas projetadas para otimizar seus fluxos de trabalho de comunicação.

Gama diversificada de soluções de números DID projetadas para aprimorar seus recursos de comunicação.

Experimente uma eficiência de comunicação incomparável com nossas soluções avançadas de entroncamento SIP.

Tecnologia de ponta para detectar e neutralizar proativamente sinalizadores de spam em seus números DID.

Permita que seus clientes se conectem com sua empresa discando um número gratuito.

Agentes de voz com inteligência artificial que atendem chamadas, capturam leads e fornecem suporte ao cliente automaticamente, a qualquer hora.
Mensagens

Onde quer que seu público esteja, nossa plataforma garante mensagens perfeitas em diversos canais.

Crie jornadas do cliente promovendo conversas interativas, tudo dentro da estrutura do seu aplicativo. 

Conecte-se com seu público de forma simples e eficaz através de nossa plataforma de SMS de última geração. 

BYOC

Aproveite o poder do IDT como sua operadora escolhida enquanto aproveita os recursos e serviços avançados de sua plataforma.

Integre o Twilio com nossa robusta plataforma de roteamento de operadora para obter um sistema de terminação de voz inigualável.

Experimente serviços de comunicação confiáveis ​​e de alta qualidade enquanto aproveita os recursos avançados da Genesys. 

Integre o IDT com a força colaborativa do MS Teams, desbloqueando uma comunicação eficiente e rica em recursos. 

Experimente o poder de nossa rede de operadoras perfeitamente conectada ao Plivo por meio de nossa solução BYOC de ponta. 

Ferramentas

Experimente o poder de nossas ferramentas de voz online, projetadas para simplificar o gerenciamento de comunicações. 

Garanta a autenticidade e a integridade das chamadas de saída com nossa ferramenta STIR/SHAKEN Verification Check. 

Ferramenta amigável para verificar a reputação do seu número comercial, garantindo que ele permaneça confiável. 

Compare e obtenha informações sobre despesas com chamadas efetuadas, otimize o orçamento e tome decisões informadas. 

Estime e compare facilmente os custos associados a diferentes provedores de números DID. 

Compare as taxas de VoIP de entrada entre os principais provedores de CPaaS e otimize seus custos de chamadas de entrada. 

Gere modelos de SMS personalizados. 

Regal

Capacite-se com os recursos necessários para prosperar no cenário dinâmico da comunicação.

Artigos que cobrem uma ampla gama de tópicos.

Descubra nossos guias em vídeo.

Obtenha respostas para perguntas comuns.

Encontre instruções para aproveitar ao máximo nossos produtos.

Mantenha-se informado com as notícias mais importantes de hoje

Descubra insights e tendências de telecomunicações.

Encontre definições de termos populares de telecomunicações.

Descubra os próximos eventos em nosso calendário.
Empresa

Um parceiro global de telecomunicações criado para atender às suas necessidades. 

Descubra a história por trás do nosso compromisso em fornecer soluções inovadoras para conectar pessoas e empresas em todo o mundo. 

Saiba mais sobre nossa infraestrutura de rede robusta que se estende por todo o mundo, garantindo conectividade confiável e segura. 

Tem uma pergunta, feedback ou precisa de ajuda? Nossa equipe dedicada está aqui para ajudar!

Encontre parceiros ou inscreva-se em programas de parceria.

NYSE: IDT
Empresa

Desenvolvedores

API SMS para nossa solução SMS Gateway

Autenticação

Para autenticar com IDT Express HTTP API (POST), você precisa passar sua chave de API como valor no cabeçalho da solicitação, o nome da chave a ser usada é “X-ApiKey”

Mensagens

SOLICITAÇÃO

URL: https://api.sms.idt.net/outbound/sms
Método: POST # GET também é possível
Cabeçalho: Tipo de conteúdo: application / json
Aceitar: application / json
Chave de API X: SUA CHAVE DE API # fornecido pela IDT Express
Corpo:
{ "de": "IDT Express",                   # remetente de texto máximo 11 caracteres
    "para": "491712345678",                    # sempre use o código do país
    "texto": "Mensagem de texto HTTP",             # mensagens longas serão divididas
    "codificação": "GSM7",                      # GSM7 ou UCS2
    "receiveDeliveryStatus": verdadeiro,           # solicitação DLR
    "refId": "SeuPróprioRefID"                  # seu identificador estará no DLR
}

Automatizadas

Cabeçalho: Tipo de conteúdo: application/json; charset=utf-8
Corpo:
{ "statusCode": 0, "messageIds": ["4a57b5a9-59f8-48cc-a21e-3e29cef3d7c4"] }

Retorno de chamada DLR

Considerando que uma URL de retorno fornecida por você esteja configurada em sua conta, as informações de status de entrega são enviadas a você no formato GET (POST também é possível) por padrão, como este:

https://callback.example.com/dlr?refid=YourOwnRefID&msgid=4a57b5a9-59f8-48cc-a21e-3e29cef3d7c4&state=DELIVERED&code=000&from=491712345678&to=IDT%20Express&mccmnc=26201&mcc=262&mnc=01&sent=2025-03-31T17%3A23%3A10Z&done=2025-03-31T17%3A23%3A15Z&country=Germany&network=T-Mobile&iso2=DE&iso3=DEU

Encontre informações mais detalhadas sobre a API e seus parâmetros nas páginas abaixo.

Solicitar Parâmetros

Como parâmetros de consulta (ao usar ENTRE ) ou em  POST  documento do corpo.

Parâmetro Formato Obrigatório Descrição
Desde corda x O ID do remetente a ser usado para o SMS. Veja IDs do remetente para restrições.
Para corda x O receptor MSISDN para onde o SMS deve ser enviado.
Texto corda x O conteúdo do SMS. Veja Restrições de Texto e Codificação para mais informações.
Codificação corda A codificação do conteúdo do SMS (valores permitidos: GSM7, UCS2; padrão: GSM7). Consulte Restrições de Texto e Codificação para obter mais informações.
ReceberEntregaStatus bool verdadeiro se você deseja receber informações sobre o status da entrega (padrão: falso; uma URL de retorno fornecida por você deve ser configurada em sua conta para receber informações sobre o status da entrega).
RefId corda Um ID de referência opcional que será incluído nos retornos de informações de status de entrega correspondentes.
Rebarba (Flash) bool verdadeiro se você quiser enviar o SMS como mensagem flash; ele será exibido instantaneamente na tela do dispositivo de destino (padrão: falso).

Corpo de resposta

Além dos códigos de status HTTP, cada resposta bem-sucedida conterá:

Campo Formato Descrição
Código de status int O código de status da chamada. Veja Códigos de status.
IDs de mensagem corda Uma matriz contendo os IDs de todas as mensagens geradas. Contém > 1 ID para mensagens longas (concatenadas).

IDs do remetente

Um ID de remetente pode ser um número de telefone, código curto ou texto alfanumérico.

Telefone

O comprimento do número de telefone depende das restrições do país, geralmente entre 9 e 16 dígitos. O código do país precisa ser incluído, mas o sinal de + é opcional.

Código curto

O comprimento do código curto também depende das restrições do país. Geralmente, ele tem entre 3 e 8 dígitos. Não coloque nenhum sinal de + antes e use apenas dígitos!

Alfa Numérico

Um ID de remetente alfanumérico pode conter letras, espaços, dígitos e caracteres especiais, como –, _ e | +. O comprimento máximo de um ID de remetente alfanumérico é de 11 caracteres. Nem todos os países e redes oferecem suporte a IDs de remetente alfanuméricos, e nem todos os caracteres especiais são suportados em todos os lugares.

Restrições de texto e codificação

Comprimento máximo

Codificação padrão / GSM7

Uma mensagem codificada padrão (GSM7) pode ter no máximo 160 caracteres. Se você inserir mais caracteres, a mensagem será dividida em várias partes. Esse tipo de mensagem é chamado de mensagem longa ou mensagem concatenada. Cada parte de uma mensagem concatenada pode ter no máximo 153 caracteres. Essa quantidade menor se deve ao fato de que os outros 7 caracteres são "consumidos" por bytes informativos que informam ao dispositivo do usuário final que se trata de uma mensagem concatenada e outras informações, como contagem total de partes, contagem atual de partes, etc.

Suporte a caracteres alfabéticos por SMS

Os caracteres usados ​​em inglês são suportados pelo GSM7, o que também se aplica aos caracteres mais comuns de outras línguas romanas. Caracteres não incluídos no alfabeto GSM7 precisam ser enviados como UCS2/Unicode para uma entrega correta – defina o parâmetro Codificação como UCS2 para isso. A codificação padrão é GSM7 e não é alterada para UCS2 automaticamente.

Você pode encontrar uma visão geral sobre os caracteres suportados pelo GSM7 aqui:
https://en.wikipedia.org/wiki/GSM_03.38

Codificação UCS2 / Unicode

Uma mensagem codificada em UCS2 ou Unicode pode ter no máximo 70 caracteres Unicode (para sua informação, cada um vale 2 bytes). Se você inserir mais caracteres, a mensagem será dividida em várias partes. Esse tipo de mensagem é chamado de mensagem longa ou mensagem concatenada. Cada parte de uma mensagem concatenada pode ter no máximo 67 caracteres. Essa quantidade menor se deve ao fato de que os outros 3 caracteres Unicode são "consumidos" por bytes informativos que informam ao dispositivo do usuário final que se trata de uma mensagem concatenada e outras informações, como contagem total de partes, contagem atual de partes, etc.

Codificação binária

Binário mensagem codificada pode ter um comprimento máximo de 140 caracteres/bytes. Para o Texto parâmetro por favor use somente caracteres ASCII (8 bits). Veja Binary SMS para um exemplo de vCard.

Binário as mensagens também podem conter mais de 140 caracteres/bytes e são, então, semelhantes a GSM7 e UCS2 mensagens, divididas em várias partes. Cada parte pode então conter no máximo 134 caracteres/bytes.

Observações sobre custos

Se uma mensagem for dividida em várias partes (mensagem concatenada), você será cobrado por cada parte, pois cada parte é um SMS real. Se uma mensagem foi dividida, você pode verificar isso examinando o parâmetro de retorno messageIds; ele conterá mais de um ID caso a mensagem tenha sido dividida.

Códigos de Status HTTP

Code Descrição
200 OK – A solicitação HTTP foi bem-sucedida
401 Não autorizado – Você não especificou uma chave de API, a chave é inválida ou seu IP de origem não estava na lista de permissões da sua conta
500 Erro interno do servidor – Esperamos que você nunca receba isso; se você ainda vir isso, significa que temos um problema temporário em nossa API e já estamos trabalhando em uma solução.

Códigos de status da plataforma IDT

Code Título Descrição
Dezembro HEX
802 322 Mensagem vazia A mensagem foi bloqueada porque não tinha conteúdo.
803 323 Rejeição anti-loop Essa causa indica que a mensagem foi rejeitada devido a um mecanismo de proteção anti-loop.
804 324 Nenhuma rota disponível Esta causa indica que temporariamente nenhuma rota de suporte está disponível.
805 325 Rejeição de multi-envio Essa causa indica que a mensagem foi rejeitada porque foi enviada várias vezes em um período de tempo muito curto.
806 326 Formato de destinatário inválido Essa causa indica que a mensagem foi rejeitada devido a um formato de destinatário inválido; por exemplo, comprimento inválido.
807 327 Remetente inválido Essa causa indica que a mensagem foi rejeitada devido a um remetente inválido; por exemplo, formato alfanumérico incorreto ou caracteres inválidos.
808 328 Falha na pesquisa de número Essa causa indica que a mensagem não pôde ser roteada porque a consulta de número falhou ou retornou um erro desconhecido.
809 329 Política de Privaciade Esta causa indica que a mensagem foi bloqueada devido à proteção da privacidade do assinante (por exemplo, ao tentar enviar uma mensagem silenciosa sem permissão)
810 32 Destino não coberto Este motivo indica que a mensagem foi rejeitada porque a rede de destino não consta na lista de cobertura da conta atual. A mensagem não será cobrada. Recomendamos que você verifique novamente a planilha de cobertura mais recente fornecida pelo seu gerente de conta ou pela equipe de preços.
811 32B Comprimento de mensagem inválido Essa causa indica que a mensagem foi rejeitada porque o comprimento do conteúdo explora os padrões permitidos.
812 32C Fila cheia Este motivo indica que a mensagem foi rejeitada porque a fila para o próximo salto parece estar cheia. Recomendamos tentar novamente alguns segundos depois ou usar uma conta/gateway de backup.
813 32D Fila no dispositivo cheia Esta causa indica que a fila de mensagens recebidas no aparelho ou modem está cheia. Normalmente, tentaremos várias vezes para reenviar.
814 32E Destinatário bloqueado Esta causa indica que a mensagem para o destinatário foi bloqueada. Isso pode ter vários motivos, por exemplo, remetente na lista negra, destinatário na lista negra, filtro de conteúdo, etc.
815 32F Rota de revezamento usada Isso indica que uma rota de retransmissão ou backup foi utilizada, por exemplo, devido ao fato de a rota primária estar em fila ou apresentar problemas de capacidade semelhantes. Normalmente, uma rota de retransmissão ou backup tem qualidade igual ou superior à da rota primária.
816 330 Validade expirada Isso indica que o período de validade da mensagem expirou antes que ela pudesse ser realmente entregue.
899 383 Falha temporária da plataforma Essa causa indica que a mensagem foi rejeitada porque temos um problema temporário na plataforma, no qual os engenheiros trabalharão imediatamente.

Códigos de status de entrega

Code Título Descrição
Dezembro HEX
000 000 Nenhum erro Nenhum erro / sucesso
001 001 Número não atribuído (não alocado) Esta causa indica que o destino solicitado pela Estação Móvel não pode ser alcançado porque, embora o número esteja em um formato válido, ele não está atribuído (alocado) no momento.
010 00 Chamada barrada Esta causa indica que o serviço de bloqueio de chamadas de saída se aplica ao serviço de mensagens curtas para o destino chamado.
017 011 Falha na rede Esta causa é enviada à Estação Móvel se o MSC não puder atender a uma solicitação gerada pela Estação Móvel devido a falhas de PLMN, por exemplo, problemas no MAP.
021 015 Transferência de mensagem curta rejeitada Esta causa indica que o equipamento que envia esta causa não deseja aceitar esta mensagem curta, embora pudesse tê-la aceitado, pois o equipamento que envia esta causa não está ocupado nem é incompatível.
022 016 Congestionamento Esta causa é enviada se a solicitação de serviço não puder ser atendida devido a congestionamento (por exemplo, nenhum canal, instalação ocupada/congestionada etc.).
023 017 Capacidade de memória excedida Esta causa indica que a estação móvel não pode armazenar a mensagem curta recebida devido à falta de capacidade de armazenamento.
027 01B Assinante ausente Essa causa indica que o destino indicado pela Estação Móvel não pode ser alcançado porque está desligado ou fora de cobertura, mas outros motivos também podem ocorrer.
028 01C Assinante não identificado Esta causa indica que o assinante não está registrado no PLMN (ou seja, IMSI desconhecido).
029 01D Instalação rejeitada Esta causa indica que a facilidade solicitada pela Estação Móvel não é suportada pelo PLMN.
030 01E assinante desconhecido Essa causa indica que o assinante não está registrado no HLR (ou seja, o IMSI ou número de diretório não está alocado a um assinante).
038 026 Rede fora de ordem Essa causa indica que a rede não está funcionando corretamente e que a condição provavelmente durará um período de tempo relativamente longo; por exemplo, tentar novamente a transferência de mensagem curta imediatamente provavelmente não será bem-sucedido.
041 029 Falha temporária Essa causa indica que a rede não está funcionando corretamente e que a condição provavelmente não durará muito tempo; por exemplo, a Estação Móvel pode querer tentar outra tentativa de transferência de mensagem curta quase imediatamente.
042 02 Congestionamento Esta causa indica que o serviço de mensagens curtas não pode ser atendido devido ao alto tráfego.
069 045 Instalação solicitada não implementada Esta causa indica que a rede não consegue fornecer o serviço de mensagens curtas solicitado.
255 0FF Causa de erro não especificada Essa causa indica que houve um erro não identificado ou não especificado fornecido pelo próximo salto.

Modelos de retorno de chamada de status de entrega

Na sua conta, podemos definir um modelo para como a URL do seu DLR será chamada quando novas informações de status de entrega estiverem disponíveis. GET e POST, além de diversos parâmetros, estão disponíveis. Por padrão, todos estarão disponíveis, mas você pode solicitar um ajuste a qualquer momento. 

ParâmetroFormatoDescrição
 refazercordaO ID de referência opcional que você definiu na solicitação http inicial.
msgstrcordaO ID da mensagem correspondente. É o ID retornado pela solicitação http inicial.
estadocordaO estado da mensagem. Valores possíveis veja Message States
códigocordaAs código de status de entrega que também fornece mais informações sobre o motivo pelo qual uma mensagem está pendente ou não pôde ser entregue.
dacordaO remetente das informações de status de entrega. Normalmente, o valor do parâmetro "para" da solicitação original.
paracordaO destinatário das informações de status de entrega. Normalmente, o valor do parâmetro "de" da solicitação original.
MCCMNCcordaO MCCMNC identificado pela plataforma IDT Express
MCCcordaO MCC identificado pela plataforma IDT Express
mnccordaA multinacional identificada pela plataforma IDT Express
envieiDateTimeA data e hora em que a mensagem original foi enviada. No formato ISO-8859 (por exemplo, 2018-03-10T17:23:15Z)
feitoDateTimeA data e a hora em que as informações de status de entrega foram geradas. No formato ISO-8859.
paíscordaO país identificado pela plataforma IDT Express
redecordaA rede identificada pela plataforma IDT Express
iso2cordaO código ISO 2 de “país”
iso3cordaO código ISO 3 de “país”

Observação: Os valores dos vários parâmetros serão codificados corretamente na URL.

Estados da mensagem

Code Descrição
a DELIVERED A mensagem foi entregue ao dispositivo do usuário final.
NÃO ENTREGUE A mensagem não pôde ser entregue ao dispositivo do usuário final.
ESPERANDO A mensagem está a caminho do dispositivo do usuário final. O possível motivo para esse estado pode ser que o dispositivo esteja temporariamente desligado ou que o dispositivo esteja em uma área com baixa
cobertura.
REJEITADO A mensagem foi rejeitada. O possível motivo pode ser que algumas restrições do país de destino não correspondiam.

Exemplo

Texto Simples SMS

Solicitação GET

				
					https://api.sms.idt.net/outbound/sms?ApiKey=YOUR-API-KEY&format=json&receiveDeliveryStatus=true&from=IDT%20Express&to=491712345678&text=HTTP%20text%20message
				
			

Resposta GET

				
					{
  "statusCode": 0,
  "messageIds": [
    "acd259b3-f164-4cef-8ccf-5b5d2430b5bf"
  ]
}
				
			

Solicitar POST

				
					Host: https://api.sms.idt.net/outbound/sms
Accept: application/json
Content-Type: application/json
X-ApiKey: YOUR-API-KEY

{
    "from": "IDT Express",
    "to": "491712345678",
    "text": "HTTP text message"
}

				
			

Resposta POST

				
					HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "statusCode": 0,
    "messageIds": ["4a57b5a9-59f8-48cc-a21e-3e29cef3d7c4"]
}
				
			

SMS de texto longo

SOLICITAÇÃO

				
					POST /outbound/sms HTTP/1.1
Host: api.sms.idt.net
Accept: application/json
Content-Type: application/json
X-ApiKey: YOUR-API-KEY

{
    "from": "IDT Express",
    "to": "491712345678",
    "text": "If you send >160 GSM7 characters you will receive more than one message id. In case the encoding is set to UCS2 this will happen if you send >70 UCS2 characters. Attention: if datacoding is unspecified, the message will be processed as GSM7 - there is no automatic encoding!"
}
				
			

Automatizadas

				
					HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "statusCode": 0,
    "messageIds": [
        "f44afb66-04d4-4d24-962c-2ad63eba3c11",
        "14483b80-e521-4065-bfea-d55e63c37007"
    ]
}
				
			

Mensagens instantâneas

SOLICITAÇÃO

				
					POST /outbound/sms HTTP/1.1
Host: api.sms.idt.net
Accept: application/json
Content-Type: application/json
X-Api-Key: YOUR-API-KEY

{
    "from": "IDT Express",
    "to":"+ 491712345678",
    "text": "HTTP text message",
    "flash": true
}
				
			

Automatizadas

				
					HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "statusCode": 0,
    "messageIds": ["8b3b9415-c33b-464c-ae57-427e312435a5"]
}
				
			

Unicode Texto SMS

SOLICITAÇÃO

				
					POST /outbound/sms HTTP/1.1
Host: api.sms.idt.net
Accept: application/json
Content-Type: application/json
X-Api-Key: YOUR-API-KEY

{
    "from": "IDT Express",
    "to": "491712345678",
    "encoding": "UCS2",
    "text": "رسالة نصية HTTP"
}
				
			

Automatizadas

				
					HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "statusCode": 0,
    "messageIds": ["68f3740d-46f9-44d2-bcf4-a696d318ec71"]
}
				
			

Solicitar informações sobre o status da entrega

SOLICITAÇÃO

				
					POST /outbound/sms HTTP/1.1
Host: api.sms.idt.net
Accept: application/json
Content-Type: application/json
X-Api-Key: YOUR-API-KEY

{
    "from": "IDT Express",
    "to": "491712345678",
    "receiveDeliveryStatus": true,
    "text": "HTTP text message"
}
				
			

Automatizadas

				
					HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "statusCode": 0,
    "messageIds": ["3d00cd29-d9b6-4683-b424-12af6fd6da60"]
}
				
			

Callback

Com um modelo de retorno de chamada definido em sua conta, você receberá informações sobre o status da entrega como estas. Observe que os parâmetros incluídos, sua ordem e nomes podem ser ajustados, se necessário.

ENTRE
				
					https://callback.example.com/dlr?msgid=3d00cd29-d9b6-4683-b424-12af6fd6da60&state=DELIVERED&code=000&from=491712345678&to=IDT%20Express&mccmnc=26201&mcc=262&mnc=01&sent=2025-03-31T17%3A23%3A10Z&done=2025-03-31T17%3A23%3A15Z&country=Germany&network=T-Mobile&iso2=DE&iso3=DEU
				
			
POST
				
					Content-Type: application/json; charset=utf-8
{
    "msgid": "3d00cd29-d9b6-4683-b424-12af6fd6da60",
    "state": "DELIVERED",
    "code": "000",
    "from": "491712345678",
    "to": "IDT Express",
    "mccmnc": "26201",
    "mcc": "262",
    "mnc": "01",
    "sent": "2025-03-31T17:23:10Z",
    "done": "2025-03-31T17:23:15Z",
    "country": "Germany",
    "network": "T-Mobile",
    "iso2": "DE",
    "iso3": "DEU"
}

				
			

Solicitar informações de status de entrega com referência do cliente

SOLICITAÇÃO

				
					POST /outbound/sms HTTP/1.1
Host: api.sms.idt.net
Accept: application/json
Content-Type: application/json
X-Api-Key: YOUR-API-KEY

{
    "from": "IDT Express",
    "to": "491712345678",
    "receiveDeliveryStatus": true,
    "refId": "YourOwnRefID",
    "text": "HTTP text message"
}
				
			

Automatizadas

				
					HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "statusCode": 0,
    "messageIds": ["854873a6-74ad-435a-ab1a-670e6207fd5b"]
}
				
			

Callback

Com um modelo de retorno de chamada definido em sua conta, você receberá informações sobre o status da entrega como estas. Observe que os parâmetros incluídos, sua ordem e nomes podem ser ajustados, se necessário.

ENTRE

				
					https://callback.example.com/dlr?refid=YourOwnRefID&msgid=854873a6-74ad-435a-ab1a-670e6207fd5b&state=DELIVERED&code=000&from=491712345678&to=IDT%20Express&mccmnc=26201&mcc=262&mnc=01&sent=2025-03-31T17%3A23%3A10Z&done=2025-03-31T17%3A23%3A15Z&country=Germany&network=T-Mobile&iso2=DE&iso3=DEU
				
			

POST

				
					Content-Type: application/json; charset=utf-8
{
    "refid": "YourOwnRefID",
    "msgid": "854873a6-74ad-435a-ab1a-670e6207fd5b",
    "state": "DELIVERED",
    "code": "000",
    "from": "491712345678",
    "to": "IDT Express",
    "mccmnc": "26201",
    "mcc": "262",
    "mnc": "01",
    "sent": "2025-03-31T17:23:10Z",
    "done": "2025-03-31T17:23:15Z",
    "country": "Germany",
    "network": "T-Mobile",
    "iso2": "DE",
    "iso3": "DEU"
}

				
			

de Corretora

Obter folha de taxas de conta

Usado para recuperar a cobertura atual com taxas e futuras alterações de taxas.

Exemplo para conta HTTP/Engage – GET

				
					https://api.sms.idt.net/account/ratesheet?password=YOUR-API-KEY&format=json&WithDestinationNames=true
				
			

Exemplo de conta SMPP – GET

				
					https://api.sms.idt.net/account/ratesheet?username=YOUR-SMPP-USERNAME&password=YOUR-SMPP-PASSWORD&format=json&WithDestinationNames=true
				
			

Exemplo de saída – JSON

				
					{
  "accountName": "YOUR-ACCOUNT-NAME",
  "currency": "USD",
  "currentRates": [
    {
      "country": "Germany",
      "network": "T-Mobile",
      "mcc": "262",
      "mnc": "01",
      "mccmnc": "26201",
      "rate": 0.1
    },
    ...

				
			

Solicitar Parâmetros

Como parâmetros de consulta (ao usar GET ) ou no corpo do documento POST.

ParâmetroFormatoObrigatórioDescrição
UserNamecorda Para contas SMPP, o nome de usuário; para contas HTTP, deixe em branco.
SenhacordaxPara contas SMPP, a senha; para contas HTTP, a ApiKey.
ComNomesDeDestinobool Quando verdadeiro, o corpo da resposta conterá os dois campos adicionais country e network. Padrão: false
Formatocorda Escolha entre json ou xml

Corpo de resposta

Além dos códigos de status HTTP, cada resposta bem-sucedida conterá:

Campo

Formato

Descrição

Nome da conta

corda

O nome descritivo da conta.

Moeda

corda

A moeda da conta.

Taxas atuais

RateSheetItem[]

Uma matriz contendo os itens de cobertura atuais.

Taxas programadas

Item de folha de taxas programadas[]

Uma matriz contendo as próximas alterações de taxa/cobertura.

RateSheetItem

Campo

Formato

Descrição

País

corda

Nome do país.

Network

corda

Nome da rede.

MCC

corda

Código do país para celular

MNC

corda

Código de rede móvel

MCCMNC

corda

Código de país móvel e código de rede móvel

Taxa

decimal

A taxa atual na moeda da conta.

Item de folha de taxas programadas

Campo

Formato

Descrição

País

corda

Nome do país.

Network

corda

Nome da rede.

MCC

corda

Código do país para celular

MNC

corda

Código de rede móvel

MCCMNC

corda

Código de país móvel e código de rede móvel

Taxa

decimal

A taxa atual na moeda da conta.

VálidoDe

datetime

A data e a hora a partir de quando a alteração estará ativa. O formato é ISO8601, e.g. “2018-08-23T14:00:00.0000000Z”