API PASARELA SMS HTTP

Transcripción

1 API PASARELA SMS HTTP Existen ds psibilidades para cnectar vía HTTP HTTPS cn la pasarela: HTTP POST (máxim 16K caracteres pr petición) HTTP GET (máxim 8K caracteres pr petición) 1. Establecer una cnexión y enviar SMS a la pasarela. La petición de entrega del SMS debe de ser hecha a la siguiente dirección cn ls parámetrs detallads a cntinuación: Parámetrs: Passwrd Destin Remitente Mensaje Plantilla Cdificacin Ruta Nmbre de usuari Cntraseña Númer de destin (cn prefij de país). Si n se pne prefij, se asume que es 34 (España). Se puede pner más de un destin separad pr ; pr, Ls destins pueden ser nmbres de cntacts, de grups de la agenda, númers de móvil tds a la vez. Si se pnen grups, el mensaje se manda a tds ls cntacts del grup. Ls nmbres de cntacts grups n pueden empezar pr númers. En cas de usar nmbres (de cntacts grups) junt cn númers de móvil en este parámetr, ls númers de móvil SIEMPRE deben ir al final Opcinal. Remitente. Si n se pne se usará el definid en la platafrma web Text del mensaje. Si se desea usar text variable para cada destinatari, ls texts a sustituir deben llevar $$ delante y detrás y tmar el valr 1, 2, etc. sucesivamente para cada un. En el parámetr Fusin se pueden especificar ls valres de dichs texts. Opcinal. Nmbre de la plantilla a utilizar cm text del mensaje. Si existe este parámetr, se bvia el parámetr Mensaje. Si la plantilla n existe, se usa el text del parámetr Mensaje Opcinal. Indica si se aplica cdificación Unicde. Ls valres psibles sn nrmal unicdehex Opcinal. Ruta cntratada pr la que se debe enviar el mensaje. Si n se especifica, se usará la cnfigurada en la apsh_v8 1/7

2 Fechaenvi Peridicidad Nmbretarea DiasSuprimids Fusin web Opcinal (bligatri para prgramar envís). Fecha y hra a la que iniciar el enví prgramad. El frmat debe ser DD/MM/AAAA hh:mm Obligatri si se prgrama el enví. Especifica cada cuant tiemp debe hacerse un enví prgramad. Ls valres psibles sn unica, diaria, semanal, mensual anual Opcinal. Nmbre cn que se guarda el enví prgramad. Si n se especifica, el sistema genera un. Opcinal. Si se prgrama el enví especifica qué días de la semana NO debe prcesarse aunque le crrespnda pr peridicidad. Ls valres psibles, separads pr cma (,) sn lunes, martes, miércles, jueves, viernes, sábad y dming Opcinal. Si se usan camps variables en un mensaje, este parámetr cntiene ls valres de dichs camps. Cada camp debe ir separad pr cma (,) y, si hay más de un destinatari, el grup de camps de cada destinatari debe ir separad pr punt y cma (;) apsh_v8 2/7

3 Ejempl nrmal (mensaje=hla): estin= &remitente=remite&mensaje=hla Si se aplica cdificación Unicde, tds ls caracteres del mensaje deben estar en frmat hexadecimal cn 4 psicines pr carácter. Es imprtante resaltar que la lngitud máxima de un mensaje en cdificación Unicde es de 70 caracteres. La cdificación Unicde es necesaria si se quieren recibir crrectamente ls siguientes caracteres: ç á í ó ú ë º ª Ejempl Unicde (mensaje=españa): estin= &remitente=remite&mensaje= f10061&cdificaci n=unicdehex Ejempl enví prgramad para cada 24 de diciembre a ls grups de clientes y familia: estin=clientes,familia&mensaje=feliz Navidad para tda la familia&fechaenvi=24/12/ :00&peridicidad=anual&nmbretarea=Feliz Navidad Ejempl enví prgramad para cada día labrable: estin= &mensaje=recuerde cmunicar su llegada&fechaenvi=01/01/ :00&peridicidad=diaria&nmbretarea=Avis fichar&diassuprimids=sabad,dming Ejempl fusión (mensaje=recuerde su cita el dd/mm/aaaa a las hh:mm para cada paciente): estin= , &remitente=remite&mensaje=recuerde su cita el $$1$$ a las $$2$$&Fusin=12/11/2010,10:45;13/11/2010,11:00 Ls mensajes salientes serán: Recuerde su cita el 12/11/2010 a las 10:45 (se enviará al ) Recuerde su cita el 13/11/2010 a las 11:00 (se enviará al ) apsh_v8 3/7

4 2. Respuesta desde la pasarela cuand envía un mensaje. Cuand la pasarela recibe un mensaje, ésta devuelve una identificación de mensaje y su estad. En envís múltiples a diferentes númers se recibirá una línea de estad pr mensaje. <Estad_mensaje>,< identificación_mensaje>,< Numer_destin> Ejempl de transmisión crrecta: 1,43800, Cuand hay un fall en la transmisión, sl se devuelve el códig de errr: <Estad_mensaje>,<códig_errr> Ejempl de transmisión fallida: 0,4, Ejempl de transmisión fallida: 0,1 Estad_mensaje 1: mensaje prcesad en la pasarela 0: mensaje NO prcesad en la pasarela Identificación_mensaje Identificación del mensaje dada pr la pasarela En prgramación de envís la identificación es el númer de la tarea y n se adjunta el valr de <Numer_destin> Códigs de Errr 1: Fall en la identificación. 2: Mensaje cn prblemas. 3: Númer destin erróne. 4: sin crédit. 5: Prveedr sin crédit. apsh_v8 4/7

5 3. Slicitud de Estad de ls mensajes Si necesita btener el estad de ls mensajes enviads a la pasarela, puede hacer una petición a la siguiente dirección cn ls parámetrs detallads a cntinuación: Passwrd Idmensaje Ejempl: Nmbre de usuari Cntraseña Identificadr del mensaje RD&idmensaje=43800 La pasarela devlverá el códig crrespndiente al estad del mensaje. Ls códigs psibles y su significad sn: Estads 01 Identificación incrrecta 02 El mensaje n es del usuari 10 Entregad a la pasarela 11 Entrega retrasada (En cla, teléfn fuera de servici apagad.) 21 Entregad a la red del peradr. 22 Entregad al teléfn. 30 Sin crédit. 41 Mensaje erróne. 42 Errr intern (cntacte cn sprte) 50 Prblema general de entrega. apsh_v8 5/7

6 4. Cnsulta del sald de mensajes Si quiere cncer el sald de mensajes restante puede hacer una petición a la siguiente dirección cn ls parámetrs detallads a cntinuación: Passwrd Ruta Ejempl: Nmbre de usuari Cntraseña Opcinal. Ruta de la que se desea cncer el sald. Si n se especifica devuelve el sald de la ruta pr defect cnfigurada en la web &ruta=t1 La pasarela devlverá el númer de mensajes dispnibles. En cas de errr, devlverá un de ls tres valres siguientes: 0,1 Fall en la identificación 0,2 Parámetrs incrrects 0,98 Faltan parámetrs 0,99 Errr n especificad apsh_v8 6/7

7 5. Anulación de una tarea prgramada Se puede anular una tarea prgramada haciend una petición a la siguiente dirección cn ls parámetrs detallads a cntinuación: Passwrd IdTarea Nmbre de usuari Cntraseña Identificadr de la tarea que se desea anular. Es el valr devuelt pr la pasarela al prgramar la tarea Ejempl: SSWORD&brrar=999 La pasarela devlverá: OK ERROR. Mensaje Si ha pdid anular la tarea Si se prduce algún errr apsh_v8 7/7