VocĆŖ estĆ” aqui:
Especificação da API Obter token
Use estas informações para fornecer uma representação de token de valores de texto simples. O Marketing Cloud Engagement usa esse método de API para recuperar a representação de token de um valor de texto simples.
O engajamento envia uma solicitação HTTP POST ao URI para o servidor de token que você fornece como parte de um processo de envio de token. Essa solicitação contém uma lista de valores de token e o servidor de token responde com a lista de valores de token e os tokens associados.
Se a solicitação for enviada sem um token, o JSON de resposta na matriz de tokens não conterÔ dados. Se houver apenas um único tokenValue na solicitação e seu servidor de token não fornecer um token para ela, a resposta incluirÔ uma matriz vazia para a propriedade de tokens na resposta JSON.
A API obtém a representação de token dos dados de número de telefone. O token é armazenado no banco de dados em vez do número de telefone de origem de uma mensagem SMS de entrada.
PrƩ-requisitos
Ative SSL no ponto de extremidade. Use a autenticação de credenciais de cliente bÔsicas ou OAuth com a lista de permissões de IP no lado do servidor para autenticar chamadas de clientes.
Formato do corpo de solicitação JSON
O Marketing Cloud Engagement envia uma solicitação usando o tipo de conteúdo application/json com o corpo contendo uma matriz obrigatória de valores de token chamada tokenValues. Cada objeto tokenValue na matriz contém estas propriedades.
| Nome do parâmetro (chave) | Tipo | Obrigatório | Descrição | |
|---|---|---|---|---|
| tokenValues | Nenhum | matriz (obrigatória) | Sim | Matriz de objetos tokenValue para os quais o servidor retorna tokens. |
| Cada objeto tokenValue inclui estas propriedades: | ||||
| tokenRequestId | string (obrigatória) | Sim | O UUID (gerado por token). | |
| tokenValue | string (obrigatória) | Sim | O endereço de email ou número de telefone celular em formato claro normalizado. | |
| tokenType | string (obrigatória) | Sim | Identifica o token como um MobileNumber ou Email. | |
| privateCode | string | Não | O código privado curto ou longo de envios para telefone celular. | |
Exemplo de solicitação JSON tokenValues
{
"tokenValues": [
{
"tokenRequestId": "abc123thn567",
"tokenValue": "13172237777",
"tokenType": "MobileNumber",
"privateCode": "46356",
},
{
"tokenRequestId": "abc098thn654",
"tokenValue": "13175559911",
"tokenType": "MobileNumber",
"privateCode": "45356",
}
]
}Formato do corpo de resposta JSON
A resposta retornada em um bloco de tipo de conteúdo aplicativo/json inclui um código de status HTTP.
| Código | Mensagem | Notas |
|---|---|---|
| 200 | OK | Solicitação processada com sucesso |
| 400 | Solicitação invÔlida | Solicitação formatada incorretamente |
| 500 | Erro interno do servidor | Erro inesperado ao processar a solicitação |
| 503 | ServiƧo indisponĆvel | ServiƧo indisponĆvel no momento |
Corpo e objeto de token
| Nome do parâmetro (chave) | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| token | matriz (obrigatória) | Sim | Matriz de tokens retornados |
| Propriedade | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| tokenRequestId | string (obrigatória) | Sim | O UUID fornecido como parte da solicitação; esse valor deve corresponder a um dos valores da solicitação. |
| token | string (obrigatória) | Sim | O token usado para representar um contato de marketing. |
| subscriberKey | string | Não | Esse valor inclui a chave de assinante do contato. Forneça um valor ou uma chave aleatória serÔ fornecida. |
ConsideraƧƵes sobre o MobileConnect
Os tokens mantĆŖm um relacionamento de um para um com nĆŗmeros de telefone. Os tokens de nĆŗmero de telefone usam o mesmo valor de token mesmo que o mesmo nĆŗmero de telefone celular apareƧa para vĆ”rios contatos. Caso pretenda usar Envios acionados (API messageContact), forneƧa o paĆs real Ć frente do token de celular. O valor inteiro nĆ£o pode exceder 15 caracteres.
Exemplo de resposta
{
"tokens": [
{
"tokenRequestId": "abc123thn567",
"token": "999911112222",
"subscriberKey": "abc123456xyzā
},
{
"tokenRequestId": "abc098thn654",
"token": "999911112233",
"subscriberKey": "123abcxyz456ā
}
]
}
