Trendsic Platform Service

<back to all web services

MessagingTestRequest

Requires Authentication
The following routes are available for this service:
POST/v1/messaging/test
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class MessagingTestRequest
    {
        public virtual string RuleKey { get; set; }
        public virtual Guid BranchId { get; set; }
        public virtual Guid? LineId { get; set; }
        public virtual List<string> StepIds { get; set; } = [];
        public virtual string ToPhone { get; set; }
        public virtual bool Remember { get; set; }
    }

    public partial class MessagingTestResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<MessagingTestSend> Sent { get; set; } = [];
    }

    public partial class MessagingTestSend
    {
        public virtual string StepId { get; set; }
        public virtual string Status { get; set; }
        public virtual string Output { get; set; }
        public virtual string Body { get; set; }
        public virtual int Segments { get; set; }
        public virtual long SmsMessageId { get; set; }
    }

}

C# 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
		}
	]
}