Trendsic Platform Service

<back to all web services

MessagingTestRequest

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

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class MessagingTestRequest
            Public Overridable Property RuleKey As String
            Public Overridable Property BranchId As Guid
            Public Overridable Property LineId As Guid?
            Public Overridable Property StepIds As List(Of String) = New List(Of String)
            Public Overridable Property ToPhone As String
            Public Overridable Property Remember As Boolean
        End Class

        Public Partial Class MessagingTestResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Sent As List(Of MessagingTestSend) = New List(Of MessagingTestSend)
        End Class

        Public Partial Class MessagingTestSend
            Public Overridable Property StepId As String
            Public Overridable Property Status As String
            Public Overridable Property Output As String
            Public Overridable Property Body As String
            Public Overridable Property Segments As Integer
            Public Overridable Property SmsMessageId As Long
        End Class
    End Namespace
End Namespace

VB.NET MessagingTestRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RuleKey":"String","BranchId":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","StepIds":["String"],"ToPhone":"String","Remember":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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}]}