digitaluapi

<back to all web services

ChannelSmsMessagesLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/channel_sms_messages
ChannelSmsMessagesLookup Parameters:
NameParameterData TypeRequiredDescription
StatusCodesIdquerylongNo
ReferencequerystringNo
TenantsIdqueryintNo
ChannelMessagesIdquerylongNo
RecipientsquerystringNo
TemplatesIdqueryintNo
TemplateTextquerystringNo
DateCreatedqueryDateTimeOffsetNo
DateSentqueryDateTimeOffset?No
RetryCountqueryintNo
MessageGuidqueryGuidNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /channel_sms_messages HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		StatusCodesId: 0,
		Reference: String,
		TenantsId: 0,
		ChannelMessagesId: 0,
		Recipients: String,
		TemplatesId: 0,
		TemplateText: String,
		DateCreated: 0001-01-01T00:00:00.0000000+00:00,
		DateSent: 0001-01-01T00:00:00.0000000+00:00,
		RetryCount: 0,
		MessageGuid: 00000000000000000000000000000000,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]