| Name | Type | Description | Notes |
|---|---|---|---|
| To | string | This is the mobile number you want to send your message to. Write Australian numbers in national format (e.g. 0412345678) and international numbers (paid plans only) in E.164 format (e.g. +441234567890). Use a string for a single recipient, and an array of strings for multiple recipients, e.g. "to": ["0412345678", "+441234567890"]. If you're using the Free Trial, you can include up to 5 recipient numbers in the array. If you're using a paid plan, you can bulk send up to 500 messages at once. | |
| From | string | When the recipient receives your message, you can choose whether they'll see a virtualNumber or senderName (paid plans only) in the from field. 04xxxxxxxx: Use one of the Virtual Numbers associated with your account. You'll also be able to receive SMS replies to this number. * senderName: Choose a unique alphanumeric string of up to 11 characters (paid feature). | |
| MessageContent | Pointer to string | Use this field to send an SMS. Your text message goes here. Note: either messageContent or multimedia are required, or you can use both field if you want to send multimedia with text. | [optional] |
| Multimedia | Pointer to []Multimedia | Use this field to send an MMS. Add your image, video or audio content here. Note: either messageContent or multimedia are required, or you can use both fields if you want to send multimedia with text. Include a JSON payload with: type: the type of multimedia content file you're sending (image, audio or video) followed by the file type. Use the format 'multimedia type/file type', e.g. "image/PNG" or "audio/MP3". Supported file types: JPEG, BMP, GIF87a, GIF89a, PNG, MP3, WAV, MPEG, MPG, MP4, 3GP and US-ASCII. fileName: the name of your multimedia file. payload: the base64 encoded content. You can use this online tool to encode an image, or Base64 Guru to encode a video or audio file. | [optional] |
| RetryTimeout | Pointer to int32 | If the message is queued or unable to reach the recipient's device, tell us how many minutes the network should keep trying. Use an integer between 1 and 1440. If you don't set a value, we'll try for 10 minutes. | [optional] [default to 10] |
| ScheduleSend | Pointer to time.Time | Don't want to send the message right away? Tell us what time you want to add it to the queue for sending instead. Set the time in London Greenwich Mean Time (adjusting for any time difference) and use ISO format, e.g. "2019-08-24T15:39:00Z". You can schedule a message up to 10 days into the future. If you specify a timestamp outside of this limit, the API will return a FIELD_INVALID error. | [optional] |
| DeliveryNotification | Pointer to bool | To receive a notification when your SMS has been delivered, set this parameter to true and make sure you provide a statusCallbackUrl (paid feature). | [optional] [default to false] |
| StatusCallbackUrl | Pointer to string | Tell us the URL you want the API to call when the status of your SMS updates. To receive a status update, this field must be provided and deliveryNotification must be set to true. The status will be either: * queued – the message is in the queue for sending (default). * sent – your message has been sent from the server. * expired – we weren't able to send the message within the retryTimeout timeframe. * delivered – the message has successfully reached the recipient's device. Note that we will only be able to return this status if you set deliveryNotification to true (paid feature). * undeliverable – the delivery of your message failed (paid feature). Sample callback response: <pre><code class="language-sh">{ "to":"0476543210", "from":"0401234567", "timestamp":"2022-11-10T05:06:42.823Z", "messageId":"1520b774-46b0-4415-a05f-7bcb1c032c59", "status":"delivered" }</code></pre> | [optional] |
| Tags | Pointer to []string | Create your own tags and use them to fetch and sort your messages through our other endpoints. You can assign up to 10 tags per message. | [optional] |
func NewUpdateMessageByIdRequest(to string, from string, ) *UpdateMessageByIdRequest
NewUpdateMessageByIdRequest instantiates a new UpdateMessageByIdRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
func NewUpdateMessageByIdRequestWithDefaults() *UpdateMessageByIdRequest
NewUpdateMessageByIdRequestWithDefaults instantiates a new UpdateMessageByIdRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
func (o *UpdateMessageByIdRequest) GetTo() string
GetTo returns the To field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetToOk() (*string, bool)
GetToOk returns a tuple with the To field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetTo(v string)
SetTo sets To field to given value.
func (o *UpdateMessageByIdRequest) GetFrom() string
GetFrom returns the From field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetFromOk() (*string, bool)
GetFromOk returns a tuple with the From field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetFrom(v string)
SetFrom sets From field to given value.
func (o *UpdateMessageByIdRequest) GetMessageContent() string
GetMessageContent returns the MessageContent field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetMessageContentOk() (*string, bool)
GetMessageContentOk returns a tuple with the MessageContent field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetMessageContent(v string)
SetMessageContent sets MessageContent field to given value.
func (o *UpdateMessageByIdRequest) HasMessageContent() bool
HasMessageContent returns a boolean if a field has been set.
func (o *UpdateMessageByIdRequest) GetMultimedia() []Multimedia
GetMultimedia returns the Multimedia field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetMultimediaOk() (*[]Multimedia, bool)
GetMultimediaOk returns a tuple with the Multimedia field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetMultimedia(v []Multimedia)
SetMultimedia sets Multimedia field to given value.
func (o *UpdateMessageByIdRequest) HasMultimedia() bool
HasMultimedia returns a boolean if a field has been set.
func (o *UpdateMessageByIdRequest) GetRetryTimeout() int32
GetRetryTimeout returns the RetryTimeout field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetRetryTimeoutOk() (*int32, bool)
GetRetryTimeoutOk returns a tuple with the RetryTimeout field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetRetryTimeout(v int32)
SetRetryTimeout sets RetryTimeout field to given value.
func (o *UpdateMessageByIdRequest) HasRetryTimeout() bool
HasRetryTimeout returns a boolean if a field has been set.
func (o *UpdateMessageByIdRequest) GetScheduleSend() time.Time
GetScheduleSend returns the ScheduleSend field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetScheduleSendOk() (*time.Time, bool)
GetScheduleSendOk returns a tuple with the ScheduleSend field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetScheduleSend(v time.Time)
SetScheduleSend sets ScheduleSend field to given value.
func (o *UpdateMessageByIdRequest) HasScheduleSend() bool
HasScheduleSend returns a boolean if a field has been set.
func (o *UpdateMessageByIdRequest) GetDeliveryNotification() bool
GetDeliveryNotification returns the DeliveryNotification field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetDeliveryNotificationOk() (*bool, bool)
GetDeliveryNotificationOk returns a tuple with the DeliveryNotification field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetDeliveryNotification(v bool)
SetDeliveryNotification sets DeliveryNotification field to given value.
func (o *UpdateMessageByIdRequest) HasDeliveryNotification() bool
HasDeliveryNotification returns a boolean if a field has been set.
func (o *UpdateMessageByIdRequest) GetStatusCallbackUrl() string
GetStatusCallbackUrl returns the StatusCallbackUrl field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetStatusCallbackUrlOk() (*string, bool)
GetStatusCallbackUrlOk returns a tuple with the StatusCallbackUrl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetStatusCallbackUrl(v string)
SetStatusCallbackUrl sets StatusCallbackUrl field to given value.
func (o *UpdateMessageByIdRequest) HasStatusCallbackUrl() bool
HasStatusCallbackUrl returns a boolean if a field has been set.
func (o *UpdateMessageByIdRequest) GetTags() []string
GetTags returns the Tags field if non-nil, zero value otherwise.
func (o *UpdateMessageByIdRequest) GetTagsOk() (*[]string, bool)
GetTagsOk returns a tuple with the Tags field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *UpdateMessageByIdRequest) SetTags(v []string)
SetTags sets Tags field to given value.
func (o *UpdateMessageByIdRequest) HasTags() bool
HasTags returns a boolean if a field has been set.