SMS Solicitud HTTP para enviar SMS: 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 POST h tt ps : //obm.ofimatic.net/api/v1/sms X - API - Key : {{ API_KEY }} Co ntent - Type : applica t io n /jso n { "phone" : s tr i n g , "message" : s tr i n g , "reference" : s tr i n g , "group" : s tr i n g , "template_id" : s tr i n g , "not_sent_after" : s tr i n g , "fields" : [ { "name" : s tr i n g , "value" : s tr i n g , "short" : boolea n } ] }
Pruebalo en Postman
Descripción de los campos Campos Descripción Obligatorio phone Numero telefónico del destinatario (formato e164 ). SI message Contenido del mensaje que sera enviado. NO reference ID de referencia del mensaje. NO template_id ID de plantilla creada, en el caso de enviar se ignora message. NO not_sent_after Todo lo que sea enviado después de la hora indicada se le coloca el estado de cancelled, el formato de hora que se debe de utilizar es UTC. Esto no es obligatorio pero es recomendable para evitar envios de notificaciones fuera del horario regulado. Ver el apartado de políticas . NO group ID de referencia grupal del mensaje. NO fields Arreglo de campos dinámicos asociados al mensaje. NO fields.name Nombre del campo. SI fields.value Valor correspondiente al campo. SI fields.short Indica si el valor del campo sera acortado. NO
Trama JSON de ejemplo 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 POST h tt ps : //obm.ofimatic.net/api/v1/sms X - Api - Key : {{ API_KEY }} Co ntent - Type : applica t io n /jso n { "phone" : "+180999999" , "message" : "Hello World" , "reference" : "8151" , "group" : "obm-api" , "template_id" : "60b7720a-8129-4f31-9ea9-457f77cde3de" , "not_sent_after" : "2024-02-12T23:30:59Z" , "fields" : [ { "name" : "cuota" , "value" : "138.98" , } ] }
Pruebalo en Postman
Respuesta Si el mensaje se envía correctamente retorna el código 200 OK con la siguiente trama JSON:
{ "id" : s tr i n g , "phone" : s tr i n g , "reference" : s tr i n g , "group" : s tr i n g , "status" : s tr i n g , "created_at" : s tr i n g }
Descripción de los campos de la respuesta Campos Descripción id Código de identificación del mensaje. phone Numero telefónico (mismo valor enviado). reference ID de referencia del mensaje (mismo valor enviado). group ID de referencia del mensaje (mismo valor enviado). created_at Fecha en la que se recibe el mensaje formato rfc339 . status Estado actual del mensaje. Los estados son: received y error.