GET
https://api.getincloud.online/raven/v3/codesListar códigos de usuario
Recupera los códigos cortos, números largos o IDs alfanuméricos asociados con tu cuenta.
API de Mensajería
Necesitas una clave de API. Pídela a nuestro equipo de soporte o créala desde la plataforma.
Este endpoint permite recuperar una lista de todos los códigos (códigos cortos, números largos o IDs alfanuméricos) asociados con tu cuenta.
GET https://api.getincloud.online/raven/v3/codesParámetros de la consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| type | string | No | Filtra por tipo de código. Valores comunes: SHORT_CODE, LONG_CODE o ALPHANUMERIC. |
| status | string | No | Filtra por estado operativo (ej. ACTIVE, INACTIVE). |
| country | string | No | Filtra por país con el código ISO (ej. US, VE, CO). |
Encabezados
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | Sí | Token de portador. Ejemplo: Bearer <TU_TOKEN>. |
| accept | string | No | application/json. |
Respuestas
200 OK
Devuelve una lista de códigos asociados al usuario.
| Campo | Tipo | Descripción |
|---|---|---|
| codes | array de objetos | Lista de códigos disponibles. |
| codes[].id | string | Identificador único del código en el sistema. |
| codes[].code | string | Valor real del código (ej. el número 87070). |
| codes[].type | string | Tipo de código (ej. SHORT_CODE). |
| codes[].country | string | País al que pertenece el código. |
| codes[].status | string | Estado del código. |
| codes[].capabilities | array de cadenas | Funciones admitidas por el código (ej. SMS, MMS, VOICE). |
401 Unauthorized
Error de autenticación. El token es inválido o ha expirado.
{
"error": "Unauthorized"
}500 Internal Server Error
Error inesperado en el servidor al recuperar la lista de códigos.
Notas técnicas
Este endpoint sirve para identificar qué remitentes (from) están disponibles al enviar mensajes. Usa un código que coincida con el país de destino de tus destinatarios para lograr las mejores tasas de entrega.
Ejemplo de solicitud
curl --request GET \
--url https://api.getincloud.online/raven/v3/codes \
--header 'accept: application/json' \
--header 'Authorization: Bearer <TU_TOKEN>'¿Te sirvió esta página?