Movider API Reference
MoviderMoviderAPI Reference
  • API Reference
Schemas
powered by Zudoku
Viber API
Viber API

Schemas


ERR400

​object

ERR401

​object

ERR404

​object

ERR500

​object

CAMPAIGN_SCHEDULE

campaignId
​integer

ID of the campaign

Example: 1
campaignName
​string

Name of the campaign

channelName
​string

Channel name for the campaign

messageType
​string

Message type for the campaign

status
​string

Current status for the campaign

​object

Total expense for the campaign. Group by expense type

deliveryDate
​string · date-time

Delivery date for the campaign

fallback
​boolean

Fallback status of the campaign

totalPhoneNumber
​integer

Total number of phones for the campaign

CAMPAIGN_SCHEDULE_WITH_CONTENT

campaignId
​integer

ID of the campaign

Example: 1
campaignName
​string

Name of the campaign

channelName
​string

Channel name for the campaign

messageType
​string

Message type for the campaign

status
​string

Current status for the campaign

​object

Total expense for the campaign. Group by expense type

deliveryDate
​string · date-time

Delivery date for the campaign

fallback
​boolean

Fallback status of the campaign

totalPhoneNumber
​integer

Total number of phones for the campaign

​object

Content that will be sending for the request

CAMPAIGN_SCHEDULES

​CAMPAIGN_SCHEDULE
page
​integer

Current page of data

limit
​integer

Current limit of data

itemCount
​integer

Amount of all item in list

CAMPAIGN_SCHEDULE_FORM

campaignName
​string · required

Name of the campaign

​object · required

Phone numbers for the campaign

channelName
​string
  • The "channelName" field indicates the channel name or brand name used for sending messages to the recipient.
  • If you do not fill a channel name or brand name in the "channelName" field, the system will automatically use the default channel name.
  • You can send a message with your own customized channel name by registering it with Movider.
  • Please note that the "channelName" field is case-sensitive. Ensure the channel name matches the case (lowercase or uppercase) you registered with Movider.
message
​string
  • For trial accounts, you are unable to edit the body message or channel name. The system automatically sends a default message with a default channel. If you would like to customize both the message and channel name, please upgrade your account.
  • If you do not provide a channel name, or if the channel name does not match the one in your registration, the system will automatically send a default message with a default channel name. Please ensure that your channel name is correct before sending.
deliveryDate
​string · date-time

Delivery date for the campaign

Example: 2023-03-31T15:05:00.00+07:00
imageUrl
​string
  • The imageURL field in the API requires a publicly accessible URL pointing to an image resource with either a .jpeg or .png file extension as the last part of the path. For example: https://www.example.com/path/image.jpeg. The maximum allowed size for the image is 1MB.
  • Please keep in mind that sending a message with an image requires specifying the desired channelName in your request.
videoUrl
​string
  • The videoUrl field in the API requires a publicly accessible URL pointing to an video resource with only .mp4 file extension as the last part of the path. For example: https://www.example.com/path/video.mp4. The maximum allowed size for the video is 25MB.
  • Please keep in mind that sending a message with an video requires specifying the desired channelName in your request.
videoThumbnail
​string
  • The videoThumbnail field in the API requires a publicly accessible URL pointing to an image resource with either a .jpeg or .png file extension as the last part of the path. For example: https://www.example.com/path/image.jpg. The maximum allowed size for the video is 1MB.
  • Please keep in mind that, if you want to send video message you must include videoThumbnail along with videoUrl.
fileUrl
​string
  • The fileUrl field in the API requires a publicly accessible URL pointing to a file resource with a supported file extension as the last part of the path (pdf, documents, spreadsheet). For example: https://pdfobject.com/pdf/sample.pdf. The maximum allowed size for the file is 25MB.
  • When sending a message with an file, you must specify the desired channelName in your request. Additionally, when using the fileUrl field, other message types cannot be included in the same request.
​BUTTON

Sending a message with a button requires message field and validate channelName field.

OK

campaignName
​string

Name of the campaign

channelName
​string

Channel name for the campaign

deliveryDate
​string · date-time

Delivery date for the campaign

fallback
​boolean

Fallback status of the campaign

​object

Total expense for the campaign. Group by expense type

remainBalance
​number · float

Remaing balance of member, after spending in the campaign

totalPhoneNumber
​integer

Total number of phones for the campaign

​object

Content that will be sending for the request

BUTTON

Sending a message with a button requires `message` field and validate `channelName` field.
caption
​string

The message that indicate within button. The maximun allowed charecters for the caption is 30 charecters.

url
​string

The url must be valid and also accessible with public.

On this page
  • ERR400
  • ERR401
  • ERR404
  • ERR500
  • CAMPAIGN_SCHEDULE
  • CAMPAIGN_SCHEDULE_WITH_CONTENT
  • CAMPAIGN_SCHEDULES
  • CAMPAIGN_SCHEDULE_FORM
  • OK
  • BUTTON