Pera ServiceStack

<back to all web services

TextMessageQueueRequest

The following routes are available for this service:
GET/v1/TextMessageQueue
GET, POST, OPTIONS/v1/TextMessageQueue/{VirtualNumber}/{ContactNumber}

To override the Content-type in your clients 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.

POST /jsv/reply/TextMessageQueueRequest HTTP/1.1 
Host: api.publicemployeeretirementassistance.com 
Content-Type: text/jsv
Content-Length: length

{
	VirtualNumber: 0,
	ContactNumber: 0,
	Message: String,
	IncludeAll: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	TextMessageQueue: 
	[
		{
			VirtualNumber: 0,
			ContactNumber: 0,
			Message: String,
			DateCreated: 0001-01-01T00:00:00.0000000+00:00,
			InboundFlag: False,
			ReadFlag: False
		}
	],
	MessageQueueData: 
	{
		EmailUsername: String,
		DomainName: String,
		ContactName: String,
		ContactTimeZone: String,
		Organization: String,
		Unit: String,
		ApptType: String,
		Appointment: String,
		AgentName: String,
		AgentTimeZone: String,
		ApptDeleted: False,
		Notes: String
	}
}