Websms.Schema.Write (websms v1.0.0-alpha.1) View Source

TODO

Link to this section Summary

Types

address_type()

binary_sms_send_request()

content_category()

e164()

E164 formatted MSISDNs – see Wikipedia https://en.wikipedia.org/wiki/MSISDN

message_type()

Allowed values are default and voice. When using the message type default, the outgoing message type is determined based on account settings. Using the message type voice triggers a voice call.

receive_message_type()

receive_sms_binary_request()

receive_sms_delivery_report_request()

receive_sms_request()

receive_sms_response()

receive_sms_text_request()

simple_sms_send_request()

sms_send_response()

text_sms_send_request()

Link to this section Types

address_type()

Specs

address_type() :: :shortcode | :alphanumeric | :international | :national

binary_sms_send_request()

Specs

binary_sms_send_request() :: %{
  optional(:clientMessageId) => map(),
  optional(:contentCategory) => :advertisement | :informational,
  optional(:messageContent) => [String.t()],
  optional(:notificationCallbackUrl) => String.t(),
  optional(:priority) => integer(),
  :recipientAddressList => [e164()],
  optional(:sendAsFlashSms) => boolean(),
  optional(:senderAddress) => String.t(),
  optional(:senderAddressType) =>
    :shortcode | :alphanumeric | :international | :national,
  optional(:test) => boolean(),
  optional(:userDataHeaderPresent) => boolean(),
  optional(:validityPeriode) => integer()
}

content_category()

Specs

content_category() :: :advertisement | :informational

e164()

Specs

e164() :: String.t()

E164 formatted MSISDNs – see Wikipedia https://en.wikipedia.org/wiki/MSISDN

message_type()

Specs

message_type() :: :voice | :default

Allowed values are default and voice. When using the message type default, the outgoing message type is determined based on account settings. Using the message type voice triggers a voice call.

receive_message_type()

Specs

receive_message_type() :: :deliveryReport | :binary | :text

receive_sms_binary_request()

Specs

receive_sms_binary_request() :: %{
  binaryMessageContent: [String.t()],
  messageFlashSms: boolean(),
  recipientAddressType: :shortcode | :alphanumeric | :international | :national,
  senderAddressType: :shortcode | :alphanumeric | :international | :national,
  userDataHeaderPresent: boolean()
}

receive_sms_delivery_report_request()

Specs

receive_sms_delivery_report_request() :: %{
  optional(:clientMessageId) => String.t(),
  optional(:deliveredAs) => :voice | :"failover-sms" | :push | :sms,
  optional(:deliveredOn) => String.t(),
  :deliveryReportMessageStatus =>
    :rejected | :accepted | :deleted | :expired | :undelivered | :delivered,
  optional(:sentOn) => String.t(),
  :transferId => String.t()
}

receive_sms_request()

Specs

receive_sms_request() ::
  %{
    optional(:clientMessageId) => String.t(),
    optional(:deliveredAs) => :voice | :"failover-sms" | :push | :sms,
    optional(:deliveredOn) => String.t(),
    :deliveryReportMessageStatus =>
      :rejected | :accepted | :deleted | :expired | :undelivered | :delivered,
    :messageType => :deliveryReport,
    optional(:sentOn) => String.t(),
    :transferId => String.t()
  }
  | %{
      binaryMessageContent: [String.t()],
      messageFlashSms: boolean(),
      messageType: :binary,
      recipientAddressType:
        :shortcode | :alphanumeric | :international | :national,
      senderAddressType:
        :shortcode | :alphanumeric | :international | :national,
      userDataHeaderPresent: boolean()
    }
  | %{
      messageFlashSms: boolean(),
      messageType: :text,
      recipientAddressType:
        :shortcode | :alphanumeric | :international | :national,
      senderAddressType:
        :shortcode | :alphanumeric | :international | :national,
      textMessageContent: String.t()
    }

receive_sms_response()

Specs

receive_sms_response() :: %{statusCode: integer(), statusMessage: String.t()}

receive_sms_text_request()

Specs

receive_sms_text_request() :: %{
  messageFlashSms: boolean(),
  recipientAddressType: :shortcode | :alphanumeric | :international | :national,
  senderAddressType: :shortcode | :alphanumeric | :international | :national,
  textMessageContent: String.t()
}

simple_sms_send_request()

Specs

simple_sms_send_request() :: %{
  optional(:clientMessageId) => map(),
  optional(:contentCategory) => :advertisement | :informational,
  optional(:maxSmsPerMessage) => integer(),
  :messageContent => String.t(),
  optional(:messageType) => :voice | :default,
  optional(:notificationCallbackUrl) => String.t(),
  optional(:priority) => integer(),
  :recipientAddressList => [e164()],
  optional(:sendAsFlashSms) => boolean(),
  optional(:senderAddress) => String.t(),
  optional(:senderAddressType) =>
    :shortcode | :alphanumeric | :international | :national,
  optional(:test) => boolean(),
  optional(:validityPeriode) => integer()
}

sms_send_response()

Specs

sms_send_response() :: %{
  clientMessageId: String.t(),
  smsCount: integer(),
  statusCode: integer(),
  statusMessage: String.t(),
  transferId: String.t()
}

text_sms_send_request()

Specs

text_sms_send_request() :: %{
  optional(:clientMessageId) => map(),
  optional(:contentCategory) => :advertisement | :informational,
  optional(:maxSmsPerMessage) => integer(),
  :messageContent => String.t(),
  optional(:messageType) => :voice | :default,
  optional(:notificationCallbackUrl) => String.t(),
  optional(:priority) => integer(),
  :recipientAddressList => [e164()],
  optional(:sendAsFlashSms) => boolean(),
  optional(:senderAddress) => String.t(),
  optional(:senderAddressType) =>
    :shortcode | :alphanumeric | :international | :national,
  optional(:test) => boolean(),
  optional(:validityPeriode) => integer()
}