PostSms Service
On this Page:
SingleShotSms
URL | LIVE:Â https://api.relateddigital.com/resta/api/PostSms/SingleShotSms ECOMM:Â https://api.relateddigital.com/reste/api/PostSms/SingleShotSms LIVEB:Â https://api.relateddigital.com/liveb_rest/api/PostSms/SingleShotSms LIVEM:Â https://api.relateddigital.com/restm/api/PostSms/SingleShotSms |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login |
Body | Originator (string), NumberMessagePair (KeyValue []) { Â Key (string), Â Value (string) } BeginTime (DateTime) |
Sample Body | Â { Â "Originator": "EUROMSG", Â "NumberMessagePair": [{ Â "Key": "905373737373", Â "Value": "SHORT MESSAGE SERVICE WISHES GOOD DAYS :)" }], Â "BeginTime": "2016-10-19 00:00:00" } |
Sample Response | { Â "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendBulkSmsWithTypeAndKeyId
URL | LIVE:Â https://api.relateddigital.com/resta/api/postsms/SendBulkSmsWithTypeAndKeyId ECOMM:Â https://api.relateddigital.com/reste/api/postsms/SendBulkSmsWithTypeAndKeyId LIVEB:Â https://api.relateddigital.com/liveb_rest/api/postsms/SendBulkSmsWithTypeAndKeyId LIVEM:Â https://api.relateddigital.com/restm/api/postsms/SendBulkSmsWithTypeAndKeyId |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator(string): Message(string): GsmNumbers (string []): KeyIds (string []): PostType(string): BeginTime(string): EndTime(string): Â |
Sample Body | { Â "Originator": null, Â "Message": null, Â "GsmNumbers": [], Â "KeyIds": [], Â "PostType": null, Â "BeginTime": null, Â "EndTime": null } |
Sample Response | { Â "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "PacketStatus": null, Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendPersonalSmsWithTypeAndKeyId
URL | LIVE:Â https://api.relateddigital.com/resta/api/PostSms/SendPersonalSmsWithTypeAndKeyId ECOMM:Â https://api.relateddigital.com/reste/api/PostSms/SendPersonalSmsWithTypeAndKeyId LIVEB:Â https://api.relateddigital.com/liveb_rest/api/PostSms/SendPersonalSmsWithTypeAndKeyId LIVEM:Â https://api.relateddigital.com/restm/api/PostSms/SendPersonalSmsWithTypeAndKeyId |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator (string): NumberMessagePair (KeyValue []) : { Â Key (string): Â Value (string): } , KeyIds (string []): PostType(string[]): BeginTime(string): EndTime(string): |
Sample Body | Â { Â "Originator": "EUROMSG", Â "NumberMessagePair": [{ Â "Key": "905373737373", Â "Value": "SHORT MESSAGE SERVICE WISHES GOOD DAYS :)" }], Â "KeyIds": [], Â Â "PostTypes": [], Â "BeginTime": null, Â "EndTime": null } |
Sample Response | { Â "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "PacketStatus": null, Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SingleShotSmsWithTypeAndKeyId
URL | LIVE:Â https://api.relateddigital.com/resta/api/PostSms/SendPersonalSmsWithTypeAndKeyId ECOMM:Â https://api.relateddigital.com/reste/api/PostSms/SendPersonalSmsWithTypeAndKeyId LIVEB:Â https://api.relateddigital.com/liveb_rest/api/PostSms/SendPersonalSmsWithTypeAndKeyId LIVEM:Â https://api.relateddigital.com/restm/api/PostSms/SendPersonalSmsWithTypeAndKeyId |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Â Originator(string): Â GsmNumber(string): Â Message(string): Â KeyId(string): Â PostType(string): Â BeginTime(string): |
Sample Body | Â { Â "Originator": null, Â "GsmNumber": null, Â "Message": null, Â "KeyId": null, Â "PostType": null, Â "BeginTime": null } |
Sample Response | { Â "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendBulkSms
URL | LIVE:Â https://api.relateddigital.com/resta/api/PostSms/SendBulkSms ECOMM:Â https://api.relateddigital.com/reste/api/PostSms/SendBulkSms LIVEB:Â https://api.relateddigital.com/liveb_rest/api/PostSms/SendBulkSms LIVEM:Â https://api.relateddigital.com/restm/api/PostSms/SendBulkSms |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Â Originator(string), Â Message(string), Â GsmNumbers (string []): Â BeginTime(string), Â EndTime(string) Â |
Sample Body | { Â "Originator": null, Â "Message": null, Â "GsmNumbers": [], Â "BeginTime": null, Â "EndTime": null } |
Sample Response | { Â "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendPersonalSms
URL | LIVE:Â https://api.relateddigital.com/resta/api/PostSms/SendPersonalSms ECOMM:Â https://api.relateddigital.com/reste/api/PostSms/SendPersonalSms LIVEB:Â https://api.relateddigital.com/liveb_rest/api/PostSms/SendPersonalSms LIVEM:Â https://api.relateddigital.com/restm/api/PostSms/SendPersonalSms |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator (string), NumberMessagePair (KeyValue []) { Â Key (string), Â Value (string) } BeginTime (string), EndTime(string) |
Sample Body | Â { Â "Originator": "EUROMSG", Â "NumberMessagePair": [{ Â "Key": "905373737373", Â "Value": "SHORT MESSAGE SERVICE WISHES GOOD DAYS :)" }], Â "BeginTime": "2016-10-19 00:00:00" Â "EndTime": "2016-10-20 00:00:00" } *Difference time of the BeginTime and EndTime should be minimum 1 hour. |
Sample Response | { Â "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendPersonalSmsToAMember
URL | LIVE:Â https://api.relateddigital.com/resta/api/PostSms/SendPersonalSmsToAMember ECOMM:Â https://api.relateddigital.com/reste/api/PostSms/SendPersonalSmsToAMember LIVEB:Â https://api.relateddigital.com/liveb_rest/api/PostSms/SendPersonalSmsToAMember LIVEM:Â https://api.relateddigital.com/restm/api/PostSms/SendPersonalSmsToAMember |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Â Originator(string): Â Key(string): Â Value(string): Â Message(string): Â BeginTime(string): Â EndTime(string): |
Sample Body | Â { Â "Originator": null, Â "Key": null, Â "Value": null, Â "Message": null, Â "BeginTime": null, Â "EndTime": null } |
Sample Response | { Â "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
ReportSmsWithPacketId
URL | LIVE:Â https://api.relateddigital.com/resta/api/postsms/ReportSmsWithPacketIdPacketId=B8B8101D6369462 ECOMM:Â https://api.relateddigital.com/reste/api/postsms/ReportSmsWithPacketIdPacketId=B8B8101D6369462 LIVEB:Â https://api.relateddigital.com/liveb_rest/api/postsms/ReportSmsWithPacketIdPacketId=B8B8101D6369462 LIVEM:Â https://api.relateddigital.com/restm/api/postsms/ReportSmsWithPacketIdPacketId=B8B8101D6369462 |
---|---|
Http verb | GET |
Parameters | PacketId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Â |
Sample Body | |
Sample Response | { Â "PacketId": null, Â "DeliveryResults":[ { Â "GsmNumber": null, Â "DeliveryResult": null, Â "DeliveryDetail": null, Â "DeliveryTime": null, Â "DeliveredMessage": null, Â "PostType": null, Â "KeyID": null, Â "SendDate": null } ], Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetSmsBulkResult
URL | |
---|---|
Http verb | GET |
Parameters | BeginDate(string),EndDate(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Â |
Sample Body | |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "BulkReport":[ { Â "PacketId": null, Â "GsmNumber": null, Â "DeliveryStatus": null, Â "SendDate": null, Â "DeliveryDate": null, Â "DeliveryDetail": null, Â "KeyId": null, Â "PostType": null } ], Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
ReportSingleShotSms
URL | LIVE:Â https://api.relateddigital.com/resta/api/PostSms/ReportSingleShotSms?PacketId=B8B8101D6369462 ECOMM:Â https://api.relateddigital.com/reste/api/PostSms/ReportSingleShotSms?PacketId=B8B8101D6369462 LIVEB:Â https://api.relateddigital.com/liveb_rest/api/PostSms/ReportSingleShotSms?PacketId=B8B8101D6369462 LIVEM:Â https://api.relateddigital.com/restm/api/PostSms/ReportSingleShotSms?PacketId=B8B8101D6369462 |
---|---|
Http verb | GET |
Parameters | PacketId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Â |
Sample Body | |
Sample Response | { Â "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", Â "PacketStatus": null, Â "DeliveryResults":[ { Â "GsmNumber": null, Â "DeliveryResult": null, Â "DeliveryDetail": null, Â "DeliveryTime": null, Â "DeliveredMessage": null, Â "PostType": null, Â "KeyID": null, Â "SendDate": null } ], Â "Success": true, Â "Errors": [], Â "DetailedMessage": "", Â "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
Parent Topic:Â RMC REST API
Copyright 2020 Related Digital