{"type":"doc","content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Usage","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Before implementing this method you must get Intelli to approve your implementation. The following plan should be used for querying message status","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the query to Get UnRead Final Statuses (in the User API section)- the frequency you call this method will be determined on your message send rate and behaviour ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Messages will receive a final status not later than 49 hours after it is sent.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use the query by document Id (method shown below) to check for message status if you have not otherwise got a final status for a message after this 49 hour period. ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Endpoints","type":"text"}]},{"type":"paragraph","content":[{"text":"We'll have two endpoints:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"REST (GET): ","type":"text"},{"text":"/services/rest/message/status?username=[]&password=[]&documentId=[]","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SOAP: ","type":"text"},{"text":"/services/ws/message?wsdl","type":"text","marks":[{"type":"em"}]},{"text":" (method: status)","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"f5d4c4b2-f3a0-42df-8273-c6f130a2acf1"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1593.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" <","type":"text","marks":[{"type":"code"}]},{"text":"ser:status","type":"text","marks":[{"type":"link","attrs":{"href":"http://serstatus"}}]},{"text":">","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ?","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ?","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ?","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"What information to return?","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"For the REST endpoint (JSON)","type":"text"}]},{"type":"paragraph","content":[{"text":" If documentId does exist","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"40d181e7-45fc-46b3-b6eb-5fef05e03a57"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"paragraph","content":[{"text":"{","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" \"documentId\": \"4fbb6c371a88393bc47baf32\",","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" \"recipient\": \"48660703691\",","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" \"messageStatus\": \"10\"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"}","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":" for when documentId does not exist","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"e834d6df-eae1-4742-824c-0d52979351ac"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[680.0]},"content":[{"type":"paragraph","content":[{"text":"{","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" \"documentId\": \"4fbb6c371a88393bc47baf32\",","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" \"messageStatus\": \"0\"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"}","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Note that we only guarantee to hold message for status query for 80 hours after message send datetime.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"For the SOAP endpoint (XML):","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"table","attrs":{"layout":"full-width","width":1800.0,"localId":"f4d295eb-503f-4bc4-b74f-5d9909ddc9b1"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1593.0]},"content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" <","type":"text","marks":[{"type":"code"}]},{"text":"ns1:sendSingle2Response","type":"text","marks":[{"type":"link","attrs":{"href":"http://ns1sendSingle2Response"}}]},{"text":" ","type":"text","marks":[{"type":"code"}]},{"text":"xmlns:ns1=","type":"text","marks":[{"type":"link","attrs":{"href":"http://xmlnsns1="}}]},{"text":"\"","type":"text","marks":[{"type":"code"}]},{"text":"http://server.submission.mc5.smspl.com/\"","type":"text","marks":[{"type":"link","attrs":{"href":"http://server.submission.mc5.smspl.com/"}}]},{"text":">","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 4fbb6cd21a88393bc47baf33 ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 48660703691","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" 10","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Status codes","type":"text"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Status_codes"}},"macroMetadata":{"macroId":{"value":"23122e3b-696a-43b7-b2b1-af97c0451e11"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"9971a147-9e47-41bc-9b53-8b79cf4a6df9"}}]},{"type":"paragraph","content":[{"text":"Full list of status code is available here ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://intellisms.atlassian.net/wiki/spaces/MC5API/pages/2594078730"}},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Submission URLs","type":"text"}]},{"type":"paragraph","content":[{"text":"To make the URLs uniform, the endpoints to submit messages will be:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"REST (GET/POST): ","type":"text"},{"text":"/services/rest/message/sendSingle2?username=[]&password=[]&documentId=[]&text=[]&replyTo=[]&recipient=[]&sender=[]","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SOAP: ","type":"text"},{"text":"/services/ws/message?wsdl","type":"text","marks":[{"type":"em"}]},{"text":" (method: ","type":"text"},{"text":"sendSingle2","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"}]}]}]}],"version":1}

Browser not supported