eCall™ User's Guide TCP/IP-Access
Contents
1. 2711 gt Connect G Choose Edit gt Paste in the menu You should now receive a result message from eCall Page 19 V1 29 Dolphin Systems AG2. If the Answer parameter is transmitted then the Callback value is ignored Format for an Answer Message described in section 4 7 Receiving address for notification as soon as the mobile phone recipient has received the message mobile phone or pager number e mail or IP an address in the logbook Notification or AlwaysNotification format is described in section 4 6 Attention Validity area of Notification or AlwaysNotification ports up to 32767 Dolphin Systems AG AlwaysNotification Receiving address for notification as soon as something has changed in the notification status pager or mobile phone Note If the AlwaysNotification parameter is transmitted the notification parameter is not needed SendDate Determines the sending time of the order in the case of delayed sending yyyy mm dd hh mm ss MsgType Delivery option for a specific type of message Defined types are Flash gt Flash SMS PrioSMS gt PrioSMS NoLog With this parameter delivery the message will not be written in the logbook Example SendPage lt TAB gt Address 41791112233 lt TAB gt Message Hello World lt TAB gt AccountName xxx lt TAB gt AccountPassword yyy lt CR gt lt LF gt SendPage lt TAB gt Address 41791112233 lt TAB gt Message Hello World lt TAB gt AccountName xxx lt TAB gt AccountPassword yyy lt TAB gt AllwaysNotification name do main ch lt TAB gt Answer name domain ch lt CR gt lt LF gt Se
3. Name of the eCall Business account Password for the eCall Business account Sendernumber Subject Sender in fax header Info in fax header Determines the sending time of the order in the case of delayed sending yyyy mm dd hh mm ss Number of retries Delay between retries Use no coversheet Dolphin Systems AG Example SendFax lt TAB gt Address 41447873071 lt TAB gt Subject Hello World lt TAB gt Message Testmessage lt CR gt lt LF gt SendFax lt TAB gt Address 41447873071 lt TAB gt Subject Test lt TAB gt Message Testmessage lt TAB gt Acco untName xxx lt TAB gt AccountPassword yyy lt TAB gt FromText 0041431234576 lt TAB gt SendDate 2009 12 20 20 50 lt TAB gt JobID 123AB lt CR gt lt LF gt 4 4 Transmission Order for Voice Messages Command SendVoice Command for a voice message Must Parameter Address Complete number internat format Message Fax message text cannot contain any tabs CrLfs must be replaced with the lt CR gt und lt LF gt characters Optional Parameter JobID Definite message identification AccountName Name of the eCall Business account AccountPassword Password for the eCall Business account Expanded Functions MessageLanguage Determines the language in which the text is read out The language parameters are as follows German DE French FR Italian IT English EN Default Language is automatically recognized FromText Contains the client s name which is read out b
4. internat format TimeStamp Shows the time of receipt of the sent message dd mm yyyy hh mm ss Read Confirmation OK lt ETX gt In order for us to note the SMS incoming message as forwarded you have to reply to the message receipt with OK lt ETX gt The connection to us will then be terminated Optional Parameter Example IncomingSMS lt TAB gt Message Time is OK Say Hi to John lt TAB gt AddressFrom 41790000000 lt TAB gt AddressTo 41763332020 lt TAB gt TimeStamp 18 09 2007 12 15 45 lt CR gt lt LF gt For each incoming message a read receipt is requested If this receipt is not transmitted the request will be retransmitted Page 14 V1 29 Dolphin Systems AG 5 Error codes ErrorCode ErrorText Description 11100 11101 11102 11103 11104 11105 11200 11201 11202 11203 11300 11301 11303 11400 11401 11402 11403 11500 11501 11502 11600 11700 11800 11911 AdrAdCInvalid Invalid or incorrect recipient s address AdrNAdinvalid Invalid or incorrect confirmation address AdrAdCMissing Recipient address missing AdrNAdMissing Notification address missing AdrAdCTooMany Too many recipient addresses transmitted AdrAdCNotAllowed Recipient address is not within defined area MsglnvalidCharacters Invalid characters in the message MsgSendTimelnvalid Invalid sending time given MsgSendTimeNotAllowed Sending time is not within time slot AccNoFreeUnits Not enough free credits in account CallSyste
5. IP Address 193 93 208 200 Source Port undefined open 0 till 65535 Dest IP freely definable Dest Port freely definable Format for transfer 192 168 0 1 1234 8 Identification eCall only accepts orders if the sender can be identified The following criteria can selectively be used in order to identify the sender e P address of sender e P address and IP port of sender e Account name and password These criteria can as a matter of course also be combined Please contact us for further identification possibilities Page 18 V1 29 Dolphin Systems AG 9 Access Test You can use TELNET for example in order to conduct a simple access test Please note the requirements for access use In addition you need to know if the account name and the account password are necessary for identification A Open a text editor e g Notepad and write an order Tabs between the parameters end with Return e g SendPage Address 41740342686 Message Test via eCall AccountName CompanyXY AccountPassword 123456 B Mark the text including the blank line that follows C Choose Copy in the menu D Start up Telnet with START gt Run gt telnet Careful Windows 2000 Telnet does not function faultlessly You can find a fully functionning version of Telnet at www ecall ch see help gt access via TCP IP E Choose Connect Remote System in the Telnet menu F Specify the hostname tcpipint1 ecall ch and port
6. a message are separated from each other by tabs Parameter ID and Value are separated by a colon The order is completed with CR LF The Parameter IDs are case insensitive i e it does not matter if you use upper or lower case letters General Format Command lt TAB gt Parameter ID 1 Parameter Value 1 lt TAB gt Parameter ID 2 Parameter Value 2 lt CR gt lt LF gt Page A V1 29 Dolphin Systems AG 4 2 Transmission Order for Text Messages Command SendPage Must Parameter Address Message Optional Parameter JobID AccountName AccountPassword Expanded Functions CallBack Answer Notification Page 5 V1 29 Command for a text message Complete pager or mobile phone number internat format or alist of numbers divided by a semicolon or aname of a person or a group specified in the address book of the eCall account Text to be displayed on the pager mobile phone cannot contain any tabs CrLfs must be replaced with the lt CR gt und lt LF gt characters Definite identification of the message Name of the eCall business account Password for the eCall business account Callback number only applicable for mobile phones up to 16 numerical or up to 11 alphanumerical characters possible You cannot use a business number as a callback number Answer function with eCall mobile phone or pager number e mail or IP anu address in the logbook only applicable for mobile phones Note
7. ELEE dE 14 5 Error EE 15 6 Status and Response Message Request Tables sssssscsccssssssssscceeeeesssssssscceeeessssesscseeeeeeessssseeees 16 6 1 EH 16 6 2 ANS WEESTATUS EE EE EE EE 16 6 3 Send StAtUs ia di aa id idad dada 16 6 4 ele 17 Page 2 V1 29 Dolphin Systems AG 7 A A O EEEESEe 18 7 1 IP Addresses for Send Requests Client gt eCall 18 7 2 IP Adress of Answers or Incomings eCall gt Client ccccccccssscccessscseesssceceessssecessseseesssseceesssseessaees 18 8 CA ON 18 9 ACCESS A AA O O OOO ONO 19 Page 3 V1 29 Dolphin Systems AG 1 Introduction With eCall s TCP IP access you can send messages to various call systems using the TCP IP protocol 2 Requirements for the Use of TCP IP Access The following requirements are necessary in order to send messages using TCP IP e You must have a Business account with eCall e Access via TCP IP must be set up in your Business account e Your software must be able to send messages using a TCP IP connection 3 Protocol The processing of a transmission order to eCall requires up to four stages 1 The client sends the transmission order to eCall 2 eCall sends a result message to the client 3 eCall sends notification to the client if requested 4 eCall sends a mobile phone recipient s return reply if requested A Message Formats 4 1 General Information All messages consist of a command word and a parameter list The specific elements of
8. JobID IPTESTANSWER lt TAB gt FromAddr ess 41791234567 lt TAB gt JobType 0 lt TAB gt AnswerState 2 lt TAB gt AnswerMessage Answer from ABC lt TAB gt FinishDate 2006 11 22 08 59 06 lt CR gt lt LF gt b when no answer message was found ResultPage lt TAB gt ResultCode 11912 lt TAB gt ResultTextJobID not found abcdef lt CR gt lt LF gt 4 10 Notification Message Command Notification Command for a notification message Must Parameter NotificationCode Message status code according to Notification Table NotificationText Status in cleartext according to Notification Table Number Contains the notification recipient s number TimeStamp Contains the time of receipt of a sent message dd mm yyyy hh mm ss Read Confirmation OK lt ETX gt In order for us to note the notification message as forwarded you have to reply to the message receipt with OK lt ETX gt The connection to us will then be terminated Optional Parameter JobID Contains the definite message identification if it was included in the transmission order Example Notification lt TAB gt NotificationCode 0 lt TAB gt NotificationText Message has been delivered lt TAB gt TimeStamp 18 09 2000 12 15 45 lt CR gt lt LF gt Page 12 V1 29 Dolphin Systems AG Notification Table NotificationCode NotificationText Description Message has been delivered The recipient confirmed the receipt of the forwarded AAA 1 Message has been buffered Receipt of the forwarded m
9. dolphin eCall User s Guide TCP IP Access systems V1 29 29 March 2011 Copyright 2011 Dolphin Systems AG Wollerau Dolphin Systems AG Informieren und Alarmieren Samstagernstrasse 45 CH 8832 Wollerau Phone 41 44 787 30 70 Fax 41 44 787 30 71 info dolphin ch e www dolphin ch eCall teere Guide ue EE ENER SEENEN ENEE EEN NEE ENEE ENEE ENNEN 1 1 Introd ctio E A 2 Requirements for the Use of TCP IP ACCOSS ccssssscccssssccesssseccessssceeesssececessnesecessseseesssseeeessseeeeessaees 4 3 PLOCOCO voi A REE ER RR n 4 4 Message ST EA 4 4 1 GENETOL Inform O EE 4 4 2 Transmission Order for Text Meszegoge s 5 4 3 Transmission Order for Fax Mesegges ineneii iai e aaa a aiaa aaa ERa 7 4 4 Transmission Order for Voice MCSSCGES ssscccccceseessssscesecsseessseeesecsceesesseassecsesssessaassessesseesaaasseseeses 8 4 5 Messag StatusReqUes EE 9 4 6 Response Message Requests td AAA AAA AAA 9 4 7 Result Message for Send Requests ccccessessssscececeesensssscesecsssessaasseseceseessasesesecseseseaseassecseseseaasaeees 10 4 8 Result Message for Status Requests cccessscscccecessessssscesecssnessaascesecsseessasesesecsssessasessseeseneneaaeaeees 10 4 9 Result for a Response Message request ocoooococcnccnonononnononnonononennnnnnnnnnnnnnnnononnnnnonnnnnnnnnnnnnonnnnonannnoos 11 4 10 NOTIFICA TION MOSSAGE cicle dicten 12 4 11 Answer Ee a ii EAR AA EA A LANAN AADEL RARAS 13 4 12 SMS INCOMING MCSSOG EC viii A E
10. efore the message SendDate Determines the sending time of the order in the case of delayed sending yyyy mm dd hh mm ss Example SendVoice lt TAB gt Address 41447873070 lt TAB gt FromText Sample John lt TAB gt Message Test Message lt CR gt lt LF gt Page 8 V1 29 Dolphin Systems AG SendVoice lt TAB gt Address 41447873070 lt TAB gt FromText John Doe lt TAB gt Message Testmessage lt TAB gt AccountName xxx lt TAB gt AccountPassword yyy lt TAB gt Mes sageLanguage FR lt TAB gt SendDate 2009 12 20 20 50 lt TAB gt JobID 123AB lt CR gt lt LF gt 4 5 Message Status Request Command GetState Command for a status request Must parameter JobID Message identification of the send request Optional parameter Address Receiver address internat format Format international numbering format 41791234567 This parameter should be supplied if the send request address was a number list or a group defined in eCall If the address is not given in such a case you ll receive the state of the last job within the Job ID AccountName Name of your eCall account AccountPassword Password of your eCall account 4 6 Response Message Request In order to be able to take advantage of this function the send request for the message has to be created with an empty Answer Parameter which means response into the logbook Command GetAnswer Command for getting the answer Must parameter JobID Job identification of the Send request Opti
11. essage could not be LJ Per 2 Message has not been been delivered Receipt of the forwarded message could not be A PRA LS 3 Error Code Error Message Determines the error at transmission to the A GT Transmission OK The transmission order was forwarded to the A e 4 11 Answer Message Command Answer Command for an answer message Must Parameter Message Shows the message that we received Number Shows the sender number of this reply internat format TimeStamp Shows the time of receipt of the sent message dd mm yyyy hh mm ss Read Confirmation OK lt ETX gt In order for us to note the answer message as forwarded you have to reply to the message receipt with OK lt ETX gt The connection to us will then be terminated Optional Parameter JobID Shows the definite identification of the sent message if it was included in the transmission order Example Answer lt TAB gt Message Time is OK Say Hi to John lt TAB gt Number 41793726262 lt TAB gt TimeStamp 18 09 2000 12 15 45 lt CR gt lt LF gt Page 13 V1 29 Dolphin Systems AG For each response message a read receipt is requested If this receipt is not transmitted the request will be retransmitted 4 12 SMS Incoming Message Command IncomingSMS Command for a SMS incoming message Must Parameter Message Shows the message that we received AddressTo Shows the receiver number of this message internat format AddressFrom Shows the sender number of this message
12. g document s of fax message a Processing Job group finished 43 Error oe The error detail can be found in the Field ErrorState the description in chapter 6 4 O a O Receiver could not be reached Retry pending 6 4 Error Status ErrorStatus SMS Pager Page 17 V1 29 Description No Job accepted message from gateway Connection cancelled Timeout The message could not be sent The text is too long Invalid call number Ziel Rufnummer ist eine Tonrufnummer Meldung unzul ssig Ziel Rufnummer ist eine Numeriknummer Unzul ssiges Zeichen Zu starker Verkehr Call system troubled Message from provider Syntax error Message from provider Operation not allowed Maximum messages for the address exceeded Message from provider ADC invalid Unknown error Error converting the documents No response Empty order Line busy Call rejected Unknown calling number Invalid calling number Number changed The receiver is not a fax device Connection dropped by sender Connection dropped by receiver Dolphin Systems AG 7 Connection Data 7 1 IP Addresses for Send Requests Client gt eCall Primary Access Dest IP tcpipint1 ecall ch 193 93 208 132 Dest Port 2711 Secondary Access Dest IP tcpipint2 ecall ch 193 93 208 151 Dest Port 2711 In either case the connection will be closed again 60 seconds after connection establishment 7 2 IP Adress of Answers or Incomings eCall gt Client Source
13. mInvalid Invalid call system CallSystemInvalidForUser Invalid call system for this user CallSystemNotSupported Call system is not supported CallSystemConfused Call system is temporarily out of order IDInvalid ID could not be found IDDoesNotExist 1D does not exist in the system StateAlreadyTransmitted Message already transmitted DataReadError Data contents could not be read CBMsgError Callback contains a forbidden number or text JobIDRequired The status request does not contain a JobID 11912 JobIDNotFound No job was found with the supplied ID Page 15 V1 29 Dolphin Systems AG 6 Status and Response Message Request Tables 6 1 Job Type JobType Description fs Im SS ENS EIN ST ingame 6 2 Answer Status JobType Description a ss answer to calor posible 6 3 Send Status Type SendStatus Description O nia RO 2 Error EN The error detail can be found in the Field ErrorState the description in chapter 6 4 eat resiste MON CI LE a Frrensmision ox Reception nOtyerconfine fae Prrensmision x Reception not confirmed ENEE DEE message successfully transferredtowoice yen C 5 reste of message to voice system was nobel OOO PY message plyedsuccessly a message played successfully and feedeak ec 85 message vit mald phone number Page 16 V1 29 Dolphin Systems AG RER 37 vo connection within defined me FEE SSCS as Freceiverisbengcaled SCS as F receiver coud not be reached reny perdiz ee Fax 101 Convertin
14. ndPage lt TAB gt Address 41791112233 lt TAB gt Message Hello World lt TAB gt AccountName xxx lt TAB gt AccountPassword yyy lt TAB gt CallBack 41791234567 lt TAB gt Notification 192 168 0 56 15300 lt TAB gt SendDate 2004 12 20 20 31 50 lt TAB gt JobID 123 AB lt CR gt lt LF gt SendPage lt TAB gt Address 41791112233 lt TAB gt Message Hello World lt TAB gt AccountName xxx lt TAB gt AccountPassword yyy lt TAB gt MsgType Flash lt TAB gt NoLog lt CR gt lt LF gt Note The contents of notification or a reply to a mobile phone pager or an e mail address are restricted to the status of notification or the reply of the recipient An exception is the JobID if this parameter was used in which case it will be inserted at the end of an e mail text Page 6 V1 29 Dolphin Systems AG 4 3 Transmission Order for Fax Messages Command SendFax Must Parameter Address Message Optional Parameter JobID AccountName AccountPassword Expanded Functions CallingNumber Subject FaxHeaderlD FaxHeaderlnfo SendDate MaxRetries RetriesTimelntervallinMin NoCoversheet Page 7 V1 29 Command for a fax message Complete fax number internat format or a list of numbers devided by a semicolon or a name of a person or a group specified in the address book of the eCall account Fax message text cannot contain any tabs CrLfs must be replaced with the lt CR gt and lt LF gt characters Definite message identification
15. onal parameter Address Receiver address internat format This parameter should be supplied if the send request address was a number list or a group defined in eCall If the address is not given in such a case you ll receive the last job within answer with this Job ID Page 9 V1 29 Dolphin Systems AG AccountName Name of your eCall account AccountPassword Password of your eCall account 4 7 Result Message for Send Requests Command ResultPage Command for a result message Must Parameter ResultCode Result code according to paragraph error codes ResultText Result in cleartext according to paragraph error codes Optional Parameter JobID Definite message identification if it was included in the transmission order Example ResultPage lt TAB gt ResultCode 0 lt TAB gt ResultText Page Accept lt CR gt lt LF gt Please note that the result message only shows that the transmission order was accepted by eCall It does not say whether or not the order was successfully transmitted to the appropriate call center or to the recipient 4 8 Result Message for Status Requests Command ResultPage Command for a result message Must parameter ResultCode Result code according to the table Error Codes ResultText Result in plain text according to the table Error Codes Optional Parameter JobID Identification of the message Address Receiver address internat format Page 10 V1 29 Dolphin Systems AG JobType Job
16. type according to table Job types SendState Send state of the job according to table Send States ErrorState Error state of the job according to table Error States PointsUsed Number of points used for the message FinishDate Finish date of the send request yyyy mm dd hh mm ss Examples a when ajob was found ResultPage lt TAB gt ResultCode 0 lt TAB gt ResultText OK lt TAB gt JobID abcdef lt TAB gt JobID abcde Address 41791234567 lt TAB gt JobType 6 lt TAB gt SendState 44 lt TAB gt ErrorState 0 lt TAB gt PointsUsed 3 lt TAB gt FinishDate 2006 10 30 08 55 28 lt CR gt lt LF gt b when no job was found ResultPage lt TAB gt ResultCode 11912 lt TAB gt ResultTextJobID not found abcdef lt CR gt lt LF gt 4 9 Result for a Response Message request Command ResultPage Command for a result message Must parameter ResultCode Result code according to the table Error Codes ResultText Result in plain text according to the table Error Codes Optional Parameter JobID Identification of the message FromAddress Sender address internat format JobType Jobtype according to table Job types AnswerState Response state according to table Response types AnswerMessage Response Message FinishDate Finish date of the response yyyy mm dd hh mm ss Page 11 V1 29 Dolphin Systems AG Examples a when an Answer message was found ResultPage lt TAB gt ResultCode 0 lt TAB gt ResultText OK lt TAB gt
Download Pdf Manuals
Related Search