API HTTP Rest/JSON EZ4U SMS Gateway

(1)

v8

TELEFONE EMAIL WEB

Rua Guerra Junqueiro 417, Porto, Portugal _{22 6063888 | 91 576 93 76} info@ez4uteam.com www.ez4uteam.com

API – HTTP Rest/JSON – EZ4U SMS Gateway

1. Envio SMS

Parâmetros de Chamada

Tópico Descrição Exemplos

URL Base http://54.154.72.85/ez4usms/API/sendSMS.php

account Nome de utilizador EZ4U

licensekey Chave de acesso à API. qwerty123

phoneNumber Número(s) do(s) destinatário(s).

Valor deverá iniciar-se por 91,92,93 ou 96 seguindo-se de 7 dígitos adicionais. Números separados por vírgula ‘,’

916155757 915769376

messageText Corpo do texto a enviar. 999 Caracteres disponíveis com substituição automática de caracteres específicos da língua portuguesa por congéneres do alfabeto inglês. Por cada bloco de 155 caracteres é utilizado 1 SMS (1º 160 caracteres) do pacote SMS em vigor. Determinados caracteres devido a restrições de codificação são contabilizados como 2.

Bom dia. Estamos a

experimentar o Sistema EZ4U.

*startDate Especificação da data de início de envio e explicitação horária Formato pretendido: YYYY-MM-DD HH:MM:SS

2013-05-16 07:33:00

*CC Especificação de centro de custos para categorização posterior 35

*alfaSender Substituição de remetente por string alfanumérica de até 11 caracteres. Parâmetro relevante apenas para clientes com funcionalidade activa em conta. Não são admissíveis caracteres de acentuação apenas os contidos nos intervalos: [A-Z] – [a-z] - [0-9]

XPTO

*TTL Período horário onde são admitidas retentativas. Valor inteiro entre 1 e 48. Aplicável apenas para chamadas com remetente alfanumérico activo.

24

*envio24 Activação/Desactivação da restrição de envio nocturno. 1 *Parâmetros opcionais

• *startDate – Por defeito colocada a data de sistema actual;

• *alfaSender – Se não utilizado, SMS terá como remetente os primeiros 11 caracteres do username do cliente • *TTL – [48] - 48 Horas por defeito;

• *envio24 – [1] - Por defeito não está habilitado o barramento de envio entre as 8h e as 23h; • *CC – [0001] Centro de Custos por defeito;

(2)

TELEFONE EMAIL WEB

Polo Mar UPTEC, Av. Liberdade s/n, F2, Matosinhos 91 576 93 76 | 91 615 57 57 info@ez4uteam.com www.ez4uteam.com

Respostas JSON

Exemplo Descrição

{"Result":"OK", "LastSMSID":11794248 ,"NrOfInsertedMessages":2, "SMSIDs":[{"SMSID":11794249, "SMSReceiverNumber":916155757},{"SMSID":11794248, " SMSReceiverNumber ":915769376}]}

Chamada realizada com sucesso com indicação do número de SMS inseridos e lista de ids

{"Result":"NOT OK", "ErrorCode":1, "ErrorDesc":"Error while connecting to DB"} Erro de ligação ao sistema de envio {"Result":"NOT OK", "ErrorCode":2, "ErrorDesc":"Wrong Credentials"} Credenciais fornecidas não estão correctas

{"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"Error Creating Message: Inserted 2 of 5 Messages"} Erro na criação de registos de SMS em sistema. Contactar a EZ4U se o problema persistir. {"Result":"NOT OK", "ErrorCode":4, "ErrorDesc":"Error Retrieving smsID"} Erro na obtenção do identificador do SMS

{"Result":"NOT OK", "ErrorCode":-1, "ErrorDesc":"Mandatory Parameters are not set"} Parâmetros obrigatórios não preenchidos na sua totalidade

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"messageText Parameter is not valid (max 999 char)"} Máximo de 999 caracteres foi ultrapassado no texto do SMS a enviar.

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"startDate is not Valid (YYYY-MM-DD HH:MM:SS)"} Data não se encontra no formato pretendido {"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"alfaSender Parameter is not valid (max 11 char)"} Máximo de 11 caracteres ultrapassado no

parâmetro alfaSender

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"phoneNumber is not Valid (9[1|2|3|6]? ??? ???)"} Formato do número de destino inválido

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"CC Parameter is not valid (max 10 char)"} Apenas 10 caracteres são permitidos na designação do centro de custos.

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"envio24h Parameter is not valid (0 | 1)"} Valor 0 para falso e 1 para verdadeiro são os únicos admissíveis para parâmetro envio24h {"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"TTL Parameter is not valid (min: 1, max: 48)"} Não foi introduzido para o parâmetro dentro do

intervalo de horas possível para colocação do SMS em regime de retentativa [1-48]

Exemplos de Chamadas

Serviço Base para Cliente sem Remetente Alfanumérico

http://54.154.72.85/ez4usms/API/sendSMS.php?account=EZ4U&licensekey=qwerty123&phoneNumber=916155757&messageText=

Ola%20Mundo&TTL=30

Serviço Base para Cliente com Remetente Alfanumérico, envio com Agendamento (2020-01-01 23:51:00) e Envio Nocturno

http://54.154.72.85/ez4usms/API/sendSMS.php?account=EZ4U&licensekey=qwerty123&phoneNumber=916155757&messageText=

Ola%20Mundo&TTL=30&envio24h=1&alfaSender=XPTO&startDate=2020-01-01%2023:51:00

Serviço Base para Cliente sem Remetente Alfanumérico, envios Múltiplos e Agendados

http://54.154.72.85/ez4usms/API/sendSMS.php?account=EZ4U&licensekey=qwerty123&phoneNumber=916155757,915769376&m essageText=Ola%20Mundo&TTL=30&envio24h=1&alfaSender=XPTO&startDate=2020-01-01%2023:51:00

(3)

TELEFONE EMAIL WEB

2. Consulta Envio SMS – Relatório de Entrega Individual

Parâmetros de Chamada

Tópico Descrição Exemplo

URL Base http://54.154.72.85/ez4usms/API/getSMSStatus.php

smsID Identificador do SMS 2220934

Respostas JSON

Exemplo Descrição { "Result": "OK", "MessageInfo": { "PhoneNumber": "967146050", "CreationTimeStamp": "2013-05-15 16:59:00", "ProcessTimeStamp": "2013-05-15 16:59:10", "DeliveryStatus": "1" } }

Chamada realizada com sucesso DeliveryStatus Codes:

• 0 – Mensagem ainda não processada

• 1 – Mensagem processada com sucesso e entregue • 2 – Mensagem processada e em entrega (pendente) • 3 – Mensagem processada sem sucesso (não entregue) • 4 – Mensagem processada e expirada (equipamento de

destino sem rede, desligado, etc)

{"Result":"OK", "MessageList":[]} Chamada realizada com sucesso – Filtro sem Resultados {"Result":"NOT OK", "ErrorCode":1, "ErrorDesc":"Error while connecting to DB"} Erro de ligação ao sistema de envio

{"Result":"NOT OK", "ErrorCode":2, "ErrorDesc":"Wrong Credentials"} Credenciais fornecidas não estão correctas {"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"SMS with ID = 120 not found"} SMS com ID especificado não foi encontrado

{"Result":"NOT OK", "ErrorCode":-1, "ErrorDesc":"Mandatory Parameters are not set"} Parâmetros obrigatórios não preenchidos na sua totalidade

Exemplos de Chamadas

Serviço Base

(4)

TELEFONE EMAIL WEB

3. Consulta Envio SMS – Relatório de Entrega Geral

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/getSMSList.php

*startDate Data de início da pesquisa de SMS 2013-05-13

*endDate Data de fim da pesquisa 2013-05-16

*fromSMSID Identificador do SMS 2196607

*Parâmetros opcionais

• *startDate – [2000-01-01] Valor por defeito; • * endDate – [2050-01-01] Valor por defeito;

(5)

TELEFONE EMAIL WEB

Respostas JSON

Exemplo Descrição { "Result": "OK", "MessageList": [ { "smsID": "2196608", "PhoneNumber": "916155757", "CreationTimeStamp": "2013-05-13 16:00:46", "ProcessTimeStamp": "2013-05-13 16:01:00", "DeliveryStatus": "1" }, { "smsID": "2196775", "PhoneNumber": "916155757", "CreationTimeStamp": "2013-05-13 16:13:42", "ProcessTimeStamp": "2013-05-13 16:13:52", "DeliveryStatus": "1" }, { "smsID": "2196776", "PhoneNumber": "916155757", "CreationTimeStamp": "2013-05-13 16:13:42", "ProcessTimeStamp": "2013-05-13 16:13:55", "DeliveryStatus": "1" }, { "smsID": "2198954", "PhoneNumber": "967146050", "CreationTimeStamp": "2013-05-13 16:59:00", "ProcessTimeStamp": "2013-05-13 16:59:10", "DeliveryStatus": "1" }, { "smsID": "2198955", "PhoneNumber": "967146050", "CreationTimeStamp": "2013-05-13 16:59:00", "ProcessTimeStamp": "2013-05-13 16:59:12", "DeliveryStatus": "1" }, { "smsID": "2198956", "PhoneNumber": "916155757", "CreationTimeStamp": "2013-05-13 16:59:00", "ProcessTimeStamp": "2013-05-13 16:59:11", "DeliveryStatus": "1" } ] }

Chamada realizada com sucesso Máximo de 250 resultados devolvidos DeliveryStatus Codes:

• 0 – Mensagem ainda não processada

• 1 – Mensagem processada com sucesso e entregue • 2 – Mensagem processada e em entrega (pendente) • 3 – Mensagem processada sem sucesso (não entregue)

{"Result":"OK", "MessageList":[]} Chamada realizada com sucesso – Filtro sem Resultados {"Result":"NOT OK", "ErrorCode":1, "ErrorDesc":"Error while connecting to DB"} Erro de ligação ao sistema de envio

(6)

TELEFONE EMAIL WEB

Polo Mar UPTEC, Av. Liberdade s/n, F2, Matosinhos 91 576 93 76 | 91 615 57 57 info@ez4uteam.com www.ez4uteam.com {"Result":"NOT OK", "ErrorCode":2, "ErrorDesc":"Wrong Credentials"} Credenciais fornecidas não estão correctas

{"Result":"NOT OK", "ErrorCode":-1, "ErrorDesc":"Mandatory Parameters are not set"} Parâmetros Obrigatórios em Falta

Exemplos de Chamadas

Serviço Base

http://54.154.72.85/ez4usms/API/getSMSList.php?account=EZ4U&licensekey=qwerty123&startDate=2013-05-13&endDate= 2013-05-16&fromSMSID=2220934

(7)

TELEFONE EMAIL WEB

4. Gestão de Listas - Criação

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/createList.php

*listTitle Nome/Título da Lista ListaTeste

*listDescription Descrição da Lista A lista dos melhores contactos *Parâmetros opcionais

• *listTitle – [DefaultTitle] – Valor por defeito; • *listDescription –[DefaultDescription] Valor por defeito;

Respostas JSON

Exemplo Descrição

{"Result":"OK", "ListID":179} Chamada realizada com sucesso com devolução de ID de nova lista

{"Result":"NOT OK", "ErrorCode":1, "ErrorDesc":"Error while connecting to DB"} Erro de acesso a BD de sistema {"Result":"NOT OK", "ErrorCode":2, "ErrorDesc":"Wrong Credentials"} Credenciais Erradas

{"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"Error Creating new List MSGDEBUG”} Erro no acesso ao sistema SMS – Guardar mensagem de DEBUG

{"Result":"NOT OK", "ErrorCode":4, "ErrorDesc":"Error Creating new List 0”} Erro na introdução de lista em sistema {"Result":"NOT OK", "ErrorCode":-1, "ErrorDesc":"Mandatory Parameters are not set"} Parâmetros Obrigatórios em Falta

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"listTitle Parameter is not valid (max 100 char)"} Máximo de 100 caracteres ultrapassado no Título da Lista

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"listDescription Parameter is not valid (max 100 char)"} Máximo de 100 caracteres ultrapassado na Descrição da Lista

Exemplos de Chamadas

Chamada completa com todos os parâmetros

http://54.154.72.85/ez4usms/API/createList.php?account=EZ4U&licensekey=qwerty123&listTitle=ListaTeste&listDescription=A%20li sta%20dos%20melhores%20contactos

(8)

TELEFONE EMAIL WEB

5. Gestão de Listas - Eliminação

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/deleteList.php

listID Identificador da lista. Número Inteiro. 100

Respostas JSON

Exemplo Descrição

{"Result":"OK"} Lista eliminada com sucesso {"Result":"NOT OK", "ErrorCode":1, "ErrorDesc":"Error while connecting to DB"} Erro de acesso a BD de sistema {"Result":"NOT OK", "ErrorCode":2, "ErrorDesc":"Wrong Credentials"} Credenciais Erradas

{"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"Error Deleting List MSGDEBUG”} Erro no acesso ao sistema SMS – Guardar mensagem de DEBUG {"Result":"NOT OK", "ErrorCode":-1, "ErrorDesc":"Mandatory Parameters are not set"} Parâmetros Obrigatórios em Falta

Exemplos de Chamadas

(9)

TELEFONE EMAIL WEB

6. Gestão de Listas – Adição de Contacto a Lista

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/addRecordsToList.php

contactList

Lista de números de contacto separados por ‘;’.

Versão actual da API admite apenas números da rede móvel portuguesa. Valor deverá iniciar-se por 91,92,93 ou 96 seguindo-se de 7 dígitos adicionais.

916155757;964318690;9112345632

Respostas JSON

Exemplo Descrição

{"Result":"OK", "NrOfInsertedContacts":3} Todos os contactos inseridos com sucesso na lista especificada com devolução de contagem visando confirmação final.

{"Result":"NOT OK", "ErrorCode":1, "ErrorDesc":"Error while connecting to DB"} Erro de acesso a BD de sistema

{"Result":"NOT OK", "ErrorCode":2, "ErrorDesc":"Wrong Credentials"} Credenciais Erradas

{"Result":"NOT OK", "ErrorCode":3, "List ID 100 not found”} A lista não foi encontrada em sistema

{"Result":"NOT OK", "ErrorCode":4, "ErrorDesc":"Error Creating new List: Inserted 2 of 3 Contacts"} Contactos foram parcialmente rejeitados. A chamada devolve número de aceites VS total de introduzidos

Exemplos de Chamadas

http://54.154.72.85/ez4usms/API/addRecordsToList.php?account=EZ4U&licensekey=qwerty123&listID=100&contactList=91615575 7;964318690;911234563

(10)

TELEFONE EMAIL WEB

7. Gestão de Listas – Remoção de Contacto de Lista

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/deleteRecordFromList.php

contactNumber Número de contacto. 916155757

Respostas JSON

Exemplo Descrição

{"Result":"OK", "NrOfDeletedSMS":1} Todos os contactos inseridos com sucesso na lista especificada com devolução de contagem visando confirmação final.

Exemplos de Chamadas

http://54.154.72.85/ez4usms/API/deleteRecordFromList.php?account=EZ4U&licensekey=qwerty123&listID=100&contactNumber=9 16155757

(11)

TELEFONE EMAIL WEB

8. Gestão de Agendamentos – Agendamentos de Campanhas

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/createCampaign.php

messageText Corpo do texto a enviar. 999 Caracteres disponíveis com substituição automática de caracteres específicos da língua portuguesa por congéneres do alfabeto inglês. Por cada bloco de 155 caracteres é utilizado 1 SMS do pacote SMS (1º bloco é de 160 caracteres) em vigor. Determinados caracteres devido a restrições de codificação são contabilizados como 2.

Bom dia. Estamos a experimentar o Sistema EZ4U.

listOfLists Conjunto de listas a serem alvo de campanha separadas por ‘;’ 211;177

*alfaSender Substituição de remetente por string alfanumérica de até 11 caracteres. Parâmetro relevante apenas para clientes com funcionalidade activa em conta. Não são admissíveis caracteres de acentuação apenas os contidos nos intervalos: [A-Z] – [a-z] - [0-9]

XPTO

*envio24h Activação/Desactivação da restrição de envio nocturno. Esta opção sobrepõe-se ao agendamento

0

*removeDuplicates Caso a lista ou o conjunto de listas incluem destinatários com 2 ou mais ocorrências, colocando este parâmetro a 1, não serão agendados mais que 1 SMS por destinatário no âmbito da campanha respectiva.

1

*campaignTitle Título da Campanha. Não tem qualquer impacto no envio do SMS. Máximo de 100 caracteres.

Campanha Promocional

*campaignDescription Descrição da Campanha. Não tem qualquer impacto no envio do SMS. Desconto para clientes *TTL Período horário onde são admitidas retentativas. Valor inteiro entre 1 e 48.

Aplicável apenas para chamadas com remetente alfanumérico activo.

8

*startDate Especificação da data de início de envio e explicitação horária Formato pretendido: YYYY-MM-DD HH:MM:SS

2013-05-16 07:33:00

• *startDate – Por defeito colocada a data de sistema actual somada de 24 horas;

• *alfaSender – Se não utilizado, SMS terá como remetente os primeiros 11 caracteres do username do cliente

• *TTL – 48 Horas por defeito;

• *envio24 – Por defeito não são enviados SMS entre as 8h e as 23h • *campaignTitle – Se não especificado: “Default Title”

• *campaignDescription – Se não especificado: “Default Description” • *removeDuplicates – Por defeito são removidos os duplicados: 1

(12)

TELEFONE EMAIL WEB

Respostas JSON

Exemplo Descrição

{"Result":"OK", "campaignID":303} Campanha inserida com sucesso em sistema com devolução do respectivo identificador.

{"Result":"NOT OK", "ErrorCode":1, "ErrorDesc":"Error while connecting to DB"} Erro de acesso a BD de sistema {"Result":"NOT OK", "ErrorCode":2, "ErrorDesc":"Wrong Credentials"} Credenciais Erradas

{"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"Not All Lists belong to this Account [EZ4U]"} Uma ou mais listas referenciadas não pertence ao utilizador colocado nas credenciais.

{"Result":"NOT OK", "ErrorCode":4, "ErrorDesc":"Error Creating Campaign"} Erro ao criar campanha.

{"Result":"NOT OK", "ErrorCode":5, "ErrorDesc":"Error Updating Campaign Final Volume"} Erro na determinação de total de destinatários da campanha.

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"messageText Parameter is not valid (max 999 char)"} Máximo de 999 caracteres foi ultrapassado no texto do SMS a enviar.

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"alfaSender Parameter is not valid (max 11 char)"} Máximo de 11 caracteres ultrapassado no parâmetro alfaSender

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"campaignTitle Parameter is not valid (max 100 char)"} Máximo de 100 caracteres ultrapassado no Título da Campanha

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"campaignDescription Parameter is not valid (max 100 char)"}

Máximo de 100 caracteres ultrapassado na Descrição da Campanha

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"listOfLists is not Valid (listID_1;listID_2;...;listID_N)"} Especificação imprecisa da lista de listas.

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"startDate is not Valid (>= 2013-05-17 16:00)"} Foi solicitado o agendamento de campanha para período não permitido pelo sistema. Data deverá ser posterior à indicada.

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"startDate is not Valid (YYYY-MM-DD HH:MM:SS)"} Data não se encontra no formato pretendido

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"envio24h Parameter is not valid (0 | 1)"} Valores admitidos diferente de 0 (inactivo) ou 1(activo) para manutenção ou remoção de duplicados

{"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"envio24h Parameter is not valid (0 | 1)"} Valor 0 para falso e 1 para verdadeiro são os únicos admissíveis para parâmetro envio24h {"Result":"NOT OK", "ErrorCode":-2, "ErrorDesc":"TTL Parameter is not valid (min: 1, max: 48)"} Não foi introduzido para o parâmetro dentro do

intervalo de horas possível para colocação do SMS em regime de retentativa [1-48]

Exemplos de Chamadas

http://54.154.72.85/ez4usms/API/createCampaign.php?account=EZ4U&licensekey=qwerty123&listOfLists=112;189&envio24h=0&r emoveDuplicates=1&campaignTitle=Teste&campaignDescription=Oportunidades%20%C3%9Anicas&startDate=

(13)

TELEFONE EMAIL WEB

9. Gestão de Agendamentos – Remoção de Campanhas

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/deleteCampaign.php

campaignID Identificador da campanha respectiva 134

Nota: A remoção de campanhas apenas produz efeitos no respectivo agendamento de SMS em caso de enquadramento temporal devidamente contextualizado. P.e. caso seja dada indicação de remoção de campanha em data posterior ao início do seu envio, apenas será removido o registo de campanha respectivo e não os SMSs subjacentes.

Respostas JSON

Exemplo Descrição

{"Result":"OK", "NrOfDeletedSMS":213} A campanha foi removida com indicação do número de SMSs removidos do agendamento em sistema. {"Result":"NOT OK", "ErrorCode":1, "ErrorDesc":"Error while connecting to DB"} Erro de acesso a BD de sistema

{"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"Error Deleting Campaign [10000000000-0]"} A campanha especificada não foi encontrada em sistema {"Result":"NOT OK", "ErrorCode":-1, "ErrorDesc":"Mandatory Parameters are not set"} Parâmetros Obrigatórios em Falta

Exemplos de Chamadas

(14)

TELEFONE EMAIL WEB

10. Bidireccionalidade – Lista de Mensagens Recebidas

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/getRxSMSList.php

fromSMSID* Identificador do SMS 2196607

startDate* Data de início da pesquisa de SMS 2013-05-13

endDate* Data de fim da pesquisa 2013-05-16

onlyUnRead* Flag para filtro de SMS não lidos 0 ou 1

markAsRead* Flag para update de SMS como lidos 0 ou 1

• * fromSMSID – Por defeito SMID >= 0 (sem filtro); • * startDate – Por defeito 2001-01-01;

• * endDate – Por defeito 2050-12-31;

• * onlyUnRead – Por defeito 0 – devolve todas as mensagens – lidas ou não lidas; • * markAsRead – Por defeito 1 – assinala todas as mensagens consultadas como lidas;

Respostas JSON

Exemplo Descrição { "Result": "OK", "MessageList": [ { "messageID": "218", "messageRawID": "17bf699e-ac8b-4b0b-8a89-b251d8d38eac", "rawTimeStamp": "2013-11-26 11:56:52", "insertTimeStamp": "2013-11-26 11:56:55", "senderNumber": "351911030887", "messageBody": "TESTE de recepcao EZ4U", "receiverNumber": "917093276", "isProcessed": "1", "isRead": "1" } ], "nrOfUpdatedMessages": 0 }

Lista de Mensagens em sistema que respeitam os critérios de pesquisa e indicação de número de mensagens que foram marcadas como lidas.

{"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"User does not exist or does not have the service enabled."}

(15)

TELEFONE EMAIL WEB

Polo Mar UPTEC, Av. Liberdade s/n, F2, Matosinhos 91 576 93 76 | 91 615 57 57 info@ez4uteam.com www.ez4uteam.com {"Result":"NOT OK", "ErrorCode":-1, "ErrorDesc":"Mandatory Parameters are not set"} Parâmetros Obrigatórios em Falta

Exemplos de Chamadas

http://54.154.72.85/ez4usms/API/getRxSMSList.php?account=EZ4U&licensekey=qwerty123&fromSMSID=203&startDate= 2013-11-25&endDate=2013-11-27&onlyUnRead=0&markAsRead=1

(16)

TELEFONE EMAIL WEB

11. Bidireccionalidade – Actualização de Estado de Mensagem

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/setRxSMSReadStatus.php

fromSMSID* Identificador do SMS 2196607

startDate* Data de início da pesquisa de SMS 2013-05-13

endDate* Data de fim da pesquisa 2013-05-16

readStatus Valor do estado da mensagem – lida ou não lida 0 ou 1

• * fromSMSID – Por defeito SMID >= 0 (sem filtro); • * startDate – Por defeito 2001-01-01;

• * endDate – Por defeito 2050-12-31;

Respostas JSON

Exemplo Descrição { "Result": "OK", "nrOfUpdatedMessages": 1 }

Indicação de Sucesso de Operação com indicação do número de mensagens efectivamente actualizadas.

{"Result":"NOT OK", "ErrorCode":2, "ErrorDesc":"Wrong Credentials"} Credenciais Erradas {"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"User does not exist or does not have the

service enabled."}

Utilizador não existe ou não tem o serviço activo

Exemplos de Chamadas

http://54.154.72.85/ez4usms/API/setRxSMSReadStatus.php?account=EZ4U&licensekey=qwerty123&fromSMSID=203&startDate=20 13-11-25&endDate=2013-11-27&readStatus=1

(17)

TELEFONE EMAIL WEB

12. Dados Utilizador – Consulta de Saldo Disponível

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/getAvailableCredits.php

Respostas JSON

Exemplo Descrição { "Result": "OK", "AvailableCreditsInfo": [ { "AvailableCredits": "UnLimited" } ] }

Indicação de Sucesso de Operação com indicação de crédito ilimitado { "Result": "OK", "AvailableCreditsInfo": [ { "Acquired": "1000", "Consumed": "4", "ConsumedLandLine": "0", "AvailableCreditsWithoutScheduled": "996", "Scheduled": "3", "AvailableCredits": "993" } ] }

Indicação de Sucesso de Operação com indicação de: • Total de Créditos Adquiridos;

• Total de Créditos já Consumidos; • Consumos Discriminados Rede Fixa; • Créditos Disponíveis sem contabilização de

mensagens agendadas; • Total Mensagens Agendadas;

• Total Créditos efectivamente Disponíves

{"Result":"NOT OK", "ErrorCode":3, "ErrorDesc":"User does not exist or does not have the service enabled."}

Utilizador não existe ou não tem o serviço activo

Exemplos de Chamadas

(18)

TELEFONE EMAIL WEB

13. Eliminação SMS Individuais Agendados – Ainda não enviados

Parâmetros de Chamada

URL Base http://54.154.72.85/ez4usms/API/deleteSMS.php

SMSID Identificador da mensagem a eliminar 123456789

Respostas JSON

Exemplo Descrição

{"Result":"OK", "NrOfDeletedSMS":1} Indicação de Sucesso de Operação com informação de número de SMS efectivamente eliminadas.

{"Result":"OK", "NrOfDeletedSMS":0} Indicação de Conclusão de operação sem que qualquer mensagem tenha sido eliminada – mensagem já enviada ou SMSID não encontrado ou SMSID não associado ao utilizador especificado.