| POST | /v1/messaging/test |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessagingTestSend:
step_id: Optional[str] = None
status: Optional[str] = None
output: Optional[str] = None
body: Optional[str] = None
segments: int = 0
sms_message_id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessagingTestResponse:
response_status: Optional[ResponseStatus] = None
sent: List[MessagingTestSend] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessagingTestRequest:
rule_key: Optional[str] = None
branch_id: Optional[str] = None
line_id: Optional[str] = None
step_ids: List[str] = field(default_factory=list)
to_phone: Optional[str] = None
remember: bool = False
Python MessagingTestRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}