Trendsic Platform Service

<back to all web services

MessagingTestRequest

Requires Authentication
The following routes are available for this service:
POST/v1/messaging/test
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MessagingTestSend() = 
        member val StepId:String = null with get,set
        member val Status:String = null with get,set
        member val Output:String = null with get,set
        member val Body:String = null with get,set
        member val Segments:Int32 = new Int32() with get,set
        member val SmsMessageId:Int64 = new Int64() with get,set

    [<AllowNullLiteral>]
    type MessagingTestResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Sent:ResizeArray<MessagingTestSend> = new ResizeArray<MessagingTestSend>() with get,set

    [<AllowNullLiteral>]
    type MessagingTestRequest() = 
        member val RuleKey:String = null with get,set
        member val BranchId:Guid = new Guid() with get,set
        member val LineId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val StepIds:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ToPhone:String = null with get,set
        member val Remember:Boolean = new Boolean() with get,set

F# MessagingTestRequest DTOs

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.

POST /v1/messaging/test HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RuleKey: String,
	BranchId: 00000000000000000000000000000000,
	LineId: 00000000000000000000000000000000,
	StepIds: 
	[
		String
	],
	ToPhone: String,
	Remember: 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,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Sent: 
	[
		{
			StepId: String,
			Status: String,
			Output: String,
			Body: String,
			Segments: 0,
			SmsMessageId: 0
		}
	]
}