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
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 ChannelSmsMessagesAddResponse:
    status_codes_id: int = 0
    reference: Optional[str] = None
    tenants_id: int = 0
    channel_messages_id: int = 0
    recipients: Optional[str] = None
    templates_id: int = 0
    template_text: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    date_sent: Optional[datetime.datetime] = None
    retry_count: int = 0
    message_guid: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChannelSmsMessagesAdd:
    # @Validate(Validator="NotNull")
    status_codes_id: int = 0

    reference: Optional[str] = None
    # @Validate(Validator="NotNull")
    tenants_id: int = 0

    # @Validate(Validator="NotNull")
    channel_messages_id: int = 0

    # @Validate(Validator="NotNull")
    recipients: Optional[str] = None

    # @Validate(Validator="NotNull")
    templates_id: int = 0

    # @Validate(Validator="NotNull")
    template_text: Optional[str] = None

    # @Validate(Validator="NotNull")
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)

    date_sent: Optional[datetime.datetime] = None
    # @Validate(Validator="NotNull")
    retry_count: int = 0

    # @Validate(Validator="NotNull")
    message_guid: Optional[str] = None

Python ChannelSmsMessagesAdd DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}