Web Service Integration

Size: px

Start display at page:

Download "Web Service Integration"

Joan Marsh
9 years ago
Views:

1 Web Service Integration API s (Application Programming Interface) ver IMPORTANT: This document is ONLY an annex to the sms.pt integration. Please read the sms.pt Web Service Integration for complete instructions.

2 2011-04-05 IMPORTANT: This document is ONLY an annex

2 About thesee API s This document contains a few web services that we have created for your convenience. Webservice Manual ver.2 HTTP API AVAILABLE LANGUAGES SEND SMS SMS STATUS GET CREDITS STATUS TABLE Page: 2

3 Available Languages You can access this API to get the currently available languages provided by our sms gateway. It is useful if you want to show the nearest available language according to the member language on your website. API: 001 Type: PRIVATE (authentication needed) Request Data Data type: xml No mandatory parameters. E_ALL require_once("lib/nusoap.php" 'username' => 'password' => => $username, $password, $clientid $cliente = new nusoap_client($service $rs = $cliente->call('get_creditos', $parametros) if($erro = $cliente->geterror()){ echo "<erro> $erro "; <creditos>9</creditos> Page: 3

API: 001 Type: PRIVATE (authentication needed) Request Data Data type: xml No mandatory parameters. E_ALL require_once("lib/nusoap.

4 Send SMS This API can be used to send SMS. It will return a list on XML format for your convenience. API: 001A Data: clientid : Your Client Identification Number username : Your Client Username for SMS.pt system login password : Your Client Password for SMS.pt system login msg : Message body (160 characters) remetente : Message sender ID case-sensitive (registered IDs only) Default ID: SMS. PT unicode : 0 = no Unicode (160 characters) / 1 = Unicode (70 characters) telemóvel : GSM number without international format (only Portuguesee network) Ex.: data hora : For schedule sms only. Leavee blank for instant sms sending. E_ALL require_once("lib/nusoap.php" $msg = $remetente = $unicode = $telemovel = $data_hora = "Mensagem de teste"; "SMS. PT"; " "; " :00:00"; 'username' 'password' 'telemovel' 'mensagem' 'remetente' 'unicode'' 'agendamento' => => $username, => $password, => $clientid, => $telemovel, => $msg, => $remetente, => $unicode, $data_hora $cliente = new nusoap_client($service $rs = $cliente->call('send sms', $parametros if($erro = $cliente->geterror()){ echo "<erro> $erro "; <estado>0</estado> <id_sms> </id_sms> Page: 4

pt system login msg : Message body (160 characters) remetente : Message sender ID case-sensitive (registered IDs only) Default ID: SMS.

5 SMS Status This API can be used to request SMS status. It will return a list on XML format for your convenience. API: 001B Data: clientid username password id_sms : Your Client Identification Number : Your Client Username for SMS.pt system login : Your Client Password for SMS.pt system login : SMS id generated on sms sending E_ALL require_once("lib/nusoap.php" $id_sms = " "; 'username' => $username, 'password' => $password, => $clientid, 'id_sms' => $id_sms $cliente = new nusoap_client($service $rs = $cliente->call('get_relatorio',$ $parametros) if( ($erro = $cliente->geterror()){ echo "<erro> $erro< "; <status>entregue</status> Page: 5

pt system login : SMS id generated on sms sending E_ALL require_once("lib/nusoap.

6 Get credits This API can be used to get the remaining credits. It will return a list on XML format for your convenience. API: 001C Data: clientid username password : Your Client Identification Number : Your Client Username for SMS.pt system login : Your Client Password for SMS.pt system login E_ALL require_once("lib/nusoap.php" 'username' => 'password' => => $username, $password, $clientid $cliente = new nusoap_client($service $rs = $cliente->call('get_creditos', $parametros) if( ($erro = $cliente->geterror()){ echo "<erro> $erro< "; <creditos>8</creditos> Page: 6

pt system login : Your Client Password for SMS.pt system login E_ALL require_once("lib/nusoap.

7 Status > Unknown error -> Username error -> Username or Password error -> ID error -> Deactivated user -> Wrong GSM number -> Insufficient credits -> Successs Page: 7

Spryng Making Business Mobile www.spryng.be [email protected] - +31 (0)207703005 Spryng Headquarters: Herengracht 138-1015 BW Amsterdam - The Netherlands

Spryng Making Business Mobile www.spryng.be info@spryng.be - +31 (0)207703005 Spryng Headquarters: Herengracht 138-1015 BW Amsterdam - The Netherlands Mobile Terminated SMS Gateway Contents: 1. Connecting to the gateway 2. Parameters 3. Return Values 4. Delivery Reports 5. Field types 6. Credit amount API 7. Example API 1. Connecting to the gateway http://www.spryng.be/send.php