Loading
Marketing Cloud Engagement
Obtener especificación de API de tokens

Obtener especificación de API de tokens

Utilice esta información para proporcionar una representación de token de los valores de texto sin formato. Marketing Cloud Engagement utiliza este método de API para recuperar la representación de token de un valor de texto sin formato.

Implicación envía una solicitud POST HTTP al URI para el servidor de tokens que proporciona como parte de un proceso de envío tokenizado. Esta solicitud contiene una lista de valores, y su servidor de token responde con la lista de valores de token y los tokens asociados.

Si la solicitud se envía sin un token, el JSON de respuesta de la matriz de tokens no contendrá ningún dato. Si solo hay un único valor de token en la solicitud y su servidor de tokens no proporciona un token, la respuesta incluirá una matriz vacía para la propiedad de token de la respuesta JSON.

La API obtiene la representación de token de datos de número de teléfono. El token se almacena en la base de datos en lugar de en el número de teléfono de origen de un mensaje SMS entrante.

Requisitos previos

Active SSL en el extremo. Utilice la autenticación de credenciales de cliente básicas o de OAuth con la lista de admisión de direcciones IP del lado del servidor para autenticar llamadas de clientes.

Formato de cuerpo de solicitud JSON

Marketing Cloud Engagement envía una solicitud utilizando el tipo de contenido application/json con el cuerpo que contiene una matriz obligatoria de valores de token denominada tokenValues. Cada objeto tokenValue de la matriz contiene estas propiedades:

Nombre de parámetro (clave) Tipo Obligatorio Descripción
tokenValue Ninguno matriz (obligatorio) Matriz de objetos tokenValue para los que el servidor devuelve tokens.
Cada objeto tokenValue incluye estas propiedades:
tokenRequestId cadena (obligatorio) El UUID (generado por token).
tokenValue cadena (obligatorio) El número de celular o la dirección de email normalizados.
tokenType cadena (obligatorio) Identifica el token como MobileNumber o Email.
privateCode cadena No El código privado corto o largo de los envíos de teléfono celular.

Solicitud de muestra de tokenValues JSON

{
  "tokenValues": [
    {
      "tokenRequestId": "abc123thn567",
      "tokenValue": "13172237777",
      "tokenType": "MobileNumber",
      "privateCode": "46356",
    },
    {
      "tokenRequestId": "abc098thn654",
      "tokenValue": "13175559911",
      "tokenType": "MobileNumber",
      "privateCode": "45356",
    }
  ]
}

Formato de cuerpo de respuesta JSON

La respuesta se devuelve en un bloque de tipo de contenido de aplicación/json con un código de estado HTTP.

Código Mensaje Notas
200 Aceptar Solicitud procesada correctamente
400 Solicitud errónea Solicitud con formato incorrecto
500 Error interno del servidor Error inesperado durante la solicitud de procesamiento
503 Servicio no disponible Servicio actualmente no disponible

Cuerpo y objeto de token

Nombre de parámetro (clave) Tipo Obligatorio Descripción
token matriz (obligatorio) Matriz de tokens devueltos
Propiedad Tipo Obligatorio Descripción
tokenRequestId cadena (obligatorio) UUID que se proporciona como parte de la solicitud: este valor debe coincidir con uno de los valores de la solicitud.
token cadena (obligatorio) El token utilizado para representar un contacto de marketing.
subscriberKey cadena No Este valor incluye la clave de suscriptor del contacto. Proporcione un valor o se proporcionará una clave aleatoria.
Nota
Nota Proporcione un token para cada tokenRequestId que se incluye en la solicitud. Los tokens no pueden incluir una cadena vacía.

Consideraciones de MobileConnect

Los tokens mantienen una relación de uno a uno con los números de teléfono. Los tokens de número de teléfono utilizan el mismo valor de token incluso si aparece ese número de celular para varios contactos. Si tiene intención de utilizar los Envíos desencadenados (messageContact API), proporcione el país real delante del token móvil. El valor completo no debe superar los 15 caracteres.

Ejemplo
Ejemplo Unas instalaciones de cambio de aceite utilizan el mismo número de celular único para varios vehículos que pertenecen a la misma familia. Estos suscriptores no están diferenciados.

Respuesta de ejemplo

{
  "tokens": [
    {
      "tokenRequestId": "abc123thn567",
      "token": "999911112222",
	"subscriberKey": "abc123456xyz”
    },
    {
      "tokenRequestId": "abc098thn654",
      "token": "999911112233",
	"subscriberKey": "123abcxyz456”
    }
  ]
}
 
Cargando
Salesforce Help | Article