digitaluapi

<back to all web services

ChannelSmsMessagesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/channel_sms_messages

export class ChannelSmsMessagesAddResponse
{
    // @DataMember(Order=2)
    public StatusCodesId: number;

    // @DataMember(Order=3)
    public Reference: string;

    // @DataMember(Order=4)
    public TenantsId: number;

    // @DataMember(Order=5)
    public ChannelMessagesId: number;

    // @DataMember(Order=6)
    public Recipients: string;

    // @DataMember(Order=7)
    public TemplatesId: number;

    // @DataMember(Order=8)
    public TemplateText: string;

    // @DataMember(Order=9)
    public DateCreated: string;

    // @DataMember(Order=10)
    public DateSent?: string;

    // @DataMember(Order=11)
    public RetryCount: number;

    // @DataMember(Order=12)
    public MessageGuid: string;

    // @DataMember(Order=14)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ChannelSmsMessagesAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ChannelSmsMessagesAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public StatusCodesId: number;

    // @DataMember(Order=3)
    public Reference: string;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public TenantsId: number;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public ChannelMessagesId: number;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public Recipients: string;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    public TemplatesId: number;

    // @DataMember(Order=8)
    // @Validate(Validator="NotNull")
    public TemplateText: string;

    // @DataMember(Order=9)
    // @Validate(Validator="NotNull")
    public DateCreated: string;

    // @DataMember(Order=10)
    public DateSent?: string;

    // @DataMember(Order=11)
    // @Validate(Validator="NotNull")
    public RetryCount: number;

    // @DataMember(Order=12)
    // @Validate(Validator="NotNull")
    public MessageGuid: string;

    public constructor(init?: Partial<ChannelSmsMessagesAdd>) { (Object as any).assign(this, init); }
}

TypeScript ChannelSmsMessagesAdd DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /channel_sms_messages HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"StatusCodesId":0,"Reference":"String","TenantsId":0,"ChannelMessagesId":0,"Recipients":"String","TemplatesId":0,"TemplateText":"String","DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","RetryCount":0,"MessageGuid":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"StatusCodesId":0,"Reference":"String","TenantsId":0,"ChannelMessagesId":0,"Recipients":"String","TemplatesId":0,"TemplateText":"String","DateCreated":"0001-01-01T00:00:00.0000000+00:00","DateSent":"0001-01-01T00:00:00.0000000+00:00","RetryCount":0,"MessageGuid":"00000000000000000000000000000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}