Estructura Api’s Aldeamo

///Estructura Api’s Aldeamo

Estructura Api’s Aldeamo

Texto

Headers

El usuario se autentica por medio de api_key en el encabezado “ApiKey” de la siguiente forma:

ApiKey = API_KEY

Adicionalmente se envía el ID del usuario con el encabezado “UserId”, de la siguiente forma:

UserId = UserId

Ejemplo de Headers:

La imagen a continuación ejemplifica los headers necesarios mencionados anteriormente.

URL para consumir el servicio de test:

https://apitellitwatest.aldeamo.com/v1/apikey/text/bsp/send

URL para consumir el servicio en producción:

https://apitellitwa.aldeamo.com/v1/apikey/text/bsp/send

Ejemplo de la petición:

Content-Type: application/json

JSON petición:

{
"from": "573003834590",
"to": "573137004535",
"type": "text",
"recipient_type": "individual",
"text": {
 "body": "testing!!"
}
}

Parametros

Estos son los principales parámetros utilizados en las solicitudes de la API POST:

Nombre Descripción
from Obligatorio. Campo que contiene el número de origen.
to Obligatorio. Campo que contiene el número de destino.
type Obligatorio El tipo de mensaje que desea enviar. Valores admitidos: text - Por defecto. Utilizado en text.
recipient_type Opcional. El tipo de destinatario al que se envía el mensaje. Valor admitido: individual
text Necesario para los mensajes de text type. Contiene un text object.
Body Contiene el cuerpo del mensaje a enviar utilizado en text

Esquema de la respuesta

Para reconocer que el envío del mensaje ha sido exitoso, obtendremos un status 200 ok y adicionalmente el identificador único del mensaje (messageUuid), todos los status estarán basados en los códigos de estados de HTTP.

Descripción de la respuesta:

En caso estar todo correcto, el servicio responde:

 

{
 "messageId": "a669add1-fb04-4da7-8d53-d76249a487dc"
}

En caso de estar mal algún dato de autenticación (ApiKey : API_KEY) , el servicio responde 401:

{
 "errors": ["Authentication Error”],
}

En caso de faltar algún dato del request, el servicio responde 400:

{
 "errors": ["Bad Request"],
}

Template

Headers

El usuario se autentica por medio de api_key en el encabezado “ApiKey” de la siguiente forma:

ApiKey = API_KEY

Adicionalmente, se envía el ID del usuario con el encabezado “UserId”, de la siguiente forma:

UserId = UserId

Ejemplo de Headers:

La imagen a continuación ejemplifica los headers necesarios mencionados anteriormente.

 

URL para consumir el servicio de test:

https://apitellitwatest.aldeamo.com/v1/apikey/template/bsp/send

URL para consumir el servicio en producción:

https://apitellitwa.aldeamo.com/v1/apikey/template/bsp/send

Ejemplo de la petición

Content-Type: application/json
JSON petición:

{
"from": "origin_wa_id",
"to": "recipient_wa_id",
"type": "template",
"template": {
"namespace": "your-namespace",
"language": {
"policy": "deterministic",
"code": "your-language-and-locale-code"
},
"name": "your-template-name",
"components": [
{
"type" : "header",
"parameters": [
# The following parameters code example includes several different possible header types,
# not all are required for a media message template API call.
{
"type": "text",
"text": "replacement_text"
}
# OR
{
"type": "document",
"document": {
"id": "your-media-id",
# filename is an optional parameter
"filename": "your-document-filename"
}
}
# OR
{
"type": "document"
,
"document": {
"link": "the
-provider
-name/protocol://the
-url"
,
# provider and filename are optional parameters
"provider": {
"name" : "provider
-name"
},
"filename": "your
-document
-filename"
}
}
# OR
{
"type": "video"
,
"video": {
"id": "your
-media
-id"
}
}
# OR
{
"type": "video"
,
"video": {
"link": "the
-provider
-name/protocol://the
-url"
# provider is an optional parameter
"provider": {
"name" : "provider
-name"
}
}
}
# OR
{
"type": "image"
,
"image": {
"link": "http(s)://the
-url"
,
# provider is an optional parameter
"provider": {
"name" : "provider
-name
},
}
}
]
# end header
},
{
"type" : "body"
,
"parameters":
[
{
"type": "text"
,
"text": "replacement_text"
},
{
"type": "currency"
,
"currency" : {
"fallback_value": "$100.99"
,
"code": "USD"
,
"amount_1000": 100990
}
},
{
"type": "date_time"
,
"date_time" : {
"fallback_value": "February 25, 1977"
,
"day_of_week":
5
,
"day_of_month": 25
,
"year": 1977
,
"month":
2
,
"hour": 15
,
"minute": 33, #OR
"timestamp": 1485470276
}
},
{
...
# Any additional template parameters
}
]
# end body
},
]
}
2022-09-23T17:09:07-05:00