Você está aqui:
Versão 2
Revise essas informações ao implementar uma API de token de resolução para envio com token no Marketing Cloud Engagement.
Essa solicitação é compatível com autenticação HTTP básica. Forneça a credencial de login ao configurar uma conta e use a conexão SSL para criptografar os nomes de usuário ou senhas. Você também pode usar OAuth2 com o tipo de concessão client_credentials.
Formato do corpo de resposta JSON
| Nome | Tipo | Obrigatório | Descrição | |
|---|---|---|---|---|
| resolvedTokens | Nenhum | matriz | Sim | Matriz de objetos ResolvedToken |
| Cada objeto resolvedTokens contém estas propriedades: | ||||
| tokenRequestId | string | Sim | UUID gerado por token durante a solicitação | |
| tokenValue | string | Sim | O endereço de email ou número de telefone resolvido. Você também pode chamar esse valor de email para compatibilidade retroativa. | |
| atributos | string | Sim | Matriz de atributos associados ao endereço de email ou número de telefone resolvido, apresentados em pares de nome e valor | |
| unresolvedTokens | Nenhum | matriz | Sim | Matriz de objetos UnresolvedToken |
| Cada matriz de unresolvedTokens contém estas propriedades: | ||||
| tokenRequestId | string | Sim | UUID gerado por token durante a solicitação | |
| Mensagem | string | Não | Mensagem de erro indicando a causa do token não resolvido | |
Exemplos de resposta HTTP
Os exemplos incluem o corpo da resposta com endereços de email e atributos, o corpo da resposta apenas com endereços de email e corpo da resposta com números de telefone.
Corpo da resposta com endereços de email e atributos
{
"resolvedTokens": [
{
"tokenRequestId":"abc123thn567",
"tokenValue": "user1@exacttarget.com",
"attributes": [
{
"name": "FirstName",
"value": "Alice"
},
{
"name": "LastName",
"value": "Smith"
}
]
},
{
"tokenRequestId":"abc098thn654",
"tokenValue ": "user2@gmail.com",
"attributes": [
{
"name": "FirstName",
"value": "John"
},
{
"name": "LastName",
"value": "Smith"
}
]
}
],
"unresolvedTokens": []
}Corpo da resposta com endereços de email
{
"resolvedTokens": [
{
"tokenRequestId":"abc123thn567",
"tokenValue": "user2@gmail.com"
}
],
"unresolvedTokens": [
{
"tokenRequestId":"abc098thn654",
"message": "Invalid token; token does not exist."
}
]
}Corpo da resposta com números de telefone
{
"resolvedTokens": [
{
"tokenRequestId":"abc123thn567",
"tokenValue": "13175551212"
}
],
"unresolvedTokens": [
{
"tokenRequestId":"abc098thn654",
"message": "Invalid token; token does not exist."
}
]
}Formato do corpo de solicitação JSON
O formato do corpo de solicitação JSON inclui um objeto JSON válido (tipo de conteúdo aplicativo/json) com estas propriedades.
Novos usuários devem usar a Versão 2 da especificação.
| Nome | Tipo | Obrigatório | Descrição | |
|---|---|---|---|---|
| tokens | Nenhum | matriz | Sim | Matriz de objetos de token |
| Cada objeto de token contém uma matriz destes objetos: | ||||
| tokenRequestId | string | Sim | UUID gerado por token | |
| token | string | Sim | Token de endereço de email ou número de telefone celular a ser resolvido | |
| subscriberKey | string | Sim | Valor de chave de assinante ou chave de contato associado ao token a ser resolvido | |
| sendKey | Nenhum | string | Sim |
|
Exemplo com endereços de email
{
"tokens": [
{
"tokenRequestId":"abc123thn567",
"token":"t1234@example.com",
"subscriberKey":"12345abcde67890fghij"
},
{
"tokenRequestId":"abc098thn654",
"token":"t5678@example.com",
"subscriberKey":"1111155555aAaAabBbBb"
}
],
"sendKey": "ExampleEmail_12345"
}Exemplo com número de telefone
{
"tokens": [
{
"tokenRequestId":"abc123thn567",
"token":"012345678901234",
"subscriberKey":"12345abcde67890fghij"
},
{
"tokenRequestId":"abc098thn654",
"token":"012345678901235",
"subscriberKey":"1111155555aAaAabBbBb"
}
],
"sendKey": "ExampleEmail_12345"
}