Saltar al contenido principal
Los nombres desde los que pueden enviarse sus mensajes, y la forma de pedir otro sin abrir el portal.
Pedir es todo lo que esto hace. Todo lo que escribe aquí se almacena a la espera de aprobación y no es utilizable. Su proveedor sirve solo lo que ha aprobado, así que nada de lo que envíe a estos endpoints cambia lo que la pasarela acepta hasta que alguien decide.Esta es la parte que más se malinterpreta: un sender ID que acaba de crear y que puede ver en la lista seguirá siendo rechazado en el envío.

Las cuatro llamadas

Disponibles a partir de la pasarela 0.9.7. Contra cualquier versión anterior no están enrutadas y responden 404.

Qué le dice un listado

Los cuatro estados

APPROVED es el único desde el que puede enviar. En particular WITHDRAWN no es una forma más suave de aprobado — un mensaje desde él se rechaza exactamente igual que uno no registrado.Se reporta a partir de la pasarela 0.9.8. Antes de eso, un registro retirado reportaba APPROVED aquí mientras su tráfico era rechazado, así que un cliente escrito contra la 0.9.7 debería tratar un estado desconocido como no utilizable en lugar de asumir tres valores.

enforcement es el campo que merece leerse primero

Con off, una fila PENDING no retiene nada. Sin este campo, una lista de filas a la espera de aprobación se lee como una cola de trabajo bloqueado, cuando en realidad nada en la cuenta se está comprobando. Se informa para la cuenta y el producto del login llamante, no para la pasarela en su conjunto.

Pedir uno

La respuesta es la fila almacenada, que leerá "status": "PENDING".

No hay campo account, y es deliberado

La cuenta y el producto vienen de sus credenciales, nunca del cuerpo. Una petición que nombre account, product o system_id se rechaza nombrando el campo con 400 Unknown argument: account en lugar de descartarlo en silencio.Descartarlo en silencio le dejaría creyendo que había registrado un sender ID para otra cuenta. Un rechazo que nombra el campo es la única respuesta honesta.
Un registro hecho de esta forma se aplica a todos los logins de su cuenta. Limitarlo a un solo login es cosa de su proveedor.

Stamps propuestos

tlvs se almacena como propuesto y nunca se aplica tal como lo envió. Donde los stamps son obligatorios —el régimen DLT de India es el caso habitual—, su proveedor decide los valores que realmente se adjuntan a su tráfico, y lee los suyos como una sugerencia. Por eso el listado llama al campo requested_tlvs en lugar de tlvs. Es lo que usted pidió, no lo que está en vigor.

Cambiar uno

PUT reemplaza; no parchea. Un campo que no envíe se borra, no se conserva. Envíe la fila completa cada vez, incluidos los campos que no cambia — lo más fácil es leer antes la fila con GET.

Una edición puede sacar de servicio un sender ID activo

Cambiar el sender ID en sí o la nota de un registro aprobado lo devuelve a PENDING, y deja de aceptarse hasta que su proveedor lo apruebe de nuevo. La decisión de su proveedor era sobre el texto antiguo, así que no se traslada. Como eso es usted deteniendo su propio tráfico, y una API no tiene formulario en el que avisarle, se rechaza a menos que diga que lo dice en serio:
Envíe "confirm_suspend": true para continuar. Lea el status de la respuesta — un PENDING de vuelta es el único aviso que recibe de que dejó de servirse. Cambiar solo el label nunca suspende nada y no necesita confirmación.

Retirar una solicitud

Responde con la lista restante, así que una sola llamada refresca su vista. Solo una solicitud PENDING puede retirarse. Quitar un sender ID aprobado es cosa de su proveedor — retirarlo aquí detendría tráfico que está fluyendo, desde un endpoint cuyo único trabajo es pedir permiso. Un id que no es suyo, que no existe o que ya no está pendiente responden todos el mismo 404. Son deliberadamente indistinguibles, para que un id no pueda sondearse para averiguar qué cuentas tienen qué registros.

Errores

Más los compartidos — véase Errores de la API.
Un 409 en POST suele ser buena noticia. “That sender ID is already approved for this account” significa que lo que quería registrar está registrado. Se responde como conflicto en lugar de como éxito porque una segunda fila para el mismo sender ID sería indistinguible de la primera.

Relacionado

Plantillas

Las mismas cuatro llamadas para la redacción que envía.

Sender IDs y plantillas

Lo mismo a través del portal, con los estados mostrados como distintivos.

Elegir un sender ID

Qué puede contener un sender ID y cómo lo tratan los operadores.

TLV personalizadas

Stamps en un mensaje individual, en lugar de en un registro.