basePath: /v1

definitions:

entities.BillingUsage:

properties:

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

end_timestamp:

example: "2022-01-31T23:59:59+00:00"

type: string

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

received_messages:

example: 465

type: integer

sent_messages:

example: 321

type: integer

start_timestamp:

example: "2022-01-01T00:00:00+00:00"

type: string

total_cost:

example: 0

type: integer

updated_at:

example: "2022-06-05T14:26:10.303278+03:00"

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

required:

- created_at

- end_timestamp

- id

- received_messages

- sent_messages

- start_timestamp

- total_cost

- updated_at

- user_id

type: object

entities.BulkMessage:

properties:

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

delivered_count:

example: 25

type: integer

expired_count:

example: 3

type: integer

failed_count:

example: 5

type: integer

pending_count:

example: 30

type: integer

request_id:

example: bulk-httpsms-file.csv

type: string

scheduled_count:

example: 50

type: integer

sent_count:

example: 40

type: integer

total:

example: 150

type: integer

required:

- created_at

- delivered_count

- expired_count

- failed_count

- pending_count

- request_id

- scheduled_count

- sent_count

- total

type: object

entities.Contact:

properties:

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

emails:

example:

- alice@example.com

items:

type: string

type: array

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

name:

example: Alice Smith

type: string

phone_numbers:

example:

- "+18005550199"

- "+18005550100"

items:

type: string

type: array

properties:

additionalProperties:

type: string

type: object

updated_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

required:

- created_at

- emails

- id

- name

- phone_numbers

- properties

- updated_at

- user_id

type: object

entities.Discord:

properties:

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

incoming_channel_id:

example: "1095780203256627291"

type: string

name:

example: Game Server

type: string

server_id:

example: "1095778291488653372"

type: string

updated_at:

example: "2022-06-05T14:26:10.303278+03:00"

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

required:

- created_at

- id

- incoming_channel_id

- name

- server_id

- updated_at

- user_id

type: object

entities.Heartbeat:

properties:

charging:

example: true

type: boolean

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

owner:

example: "+18005550199"

type: string

timestamp:

example: "2022-06-05T14:26:01.520828+03:00"

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

version:

example: 344c10f

type: string

required:

- charging

- id

- owner

- timestamp

- user_id

- version

type: object

entities.Message:

properties:

attachments:

example:

- https://example.com/image.jpg

- https://example.com/video.mp4

items:

type: string

type: array

contact:

example: "+18005550100"

type: string

content:

example: This is a sample text message

type: string

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

delivered_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

encrypted:

example: false

type: boolean

expired_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

failed_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

failure_reason:

example: UNKNOWN

type: string

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

last_attempted_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

max_send_attempts:

example: 1

type: integer

order_timestamp:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

owner:

example: "+18005550199"

type: string

received_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

request_id:

example: 153554b5-ae44-44a0-8f4f-7bbac5657ad4

type: string

request_received_at:

example: "2022-06-05T14:26:01.520828+03:00"

type: string

scheduled_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

scheduled_send_time:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

send_attempt_count:

example: 0

type: integer

send_time:

description: SendDuration is the number of nanoseconds from when the request

was received until when the mobile phone send the message

example: 133414

type: integer

sent_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

sim:

allOf:

- $ref: '#/definitions/entities.SIM'

description: |-

SIM is the SIM card to use to send the message

* SMS1: use the SIM card in slot 1

* SMS2: use the SIM card in slot 2

* DEFAULT: used the default communication SIM card

example: DEFAULT

status:

example: pending

type: string

type:

example: mobile-terminated

type: string

updated_at:

example: "2022-06-05T14:26:10.303278+03:00"

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

required:

- attachments

- contact

- content

- created_at

- encrypted

- id

- max_send_attempts

- order_timestamp

- owner

- request_received_at

- send_attempt_count

- sim

- status

- type

- updated_at

- user_id

type: object

entities.MessageSendSchedule:

properties:

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

name:

example: Business Hours

type: string

timezone:

example: Europe/Tallinn

type: string

updated_at:

example: "2022-06-05T14:26:10.303278+03:00"

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

windows:

items:

$ref: '#/definitions/entities.MessageSendScheduleWindow'

type: array

required:

- created_at

- id

- name

- timezone

- updated_at

- user_id

- windows

type: object

entities.MessageSendScheduleWindow:

properties:

day_of_week:

example: 1

type: integer

end_minute:

example: 1020

type: integer

start_minute:

example: 540

type: integer

required:

- day_of_week

- end_minute

- start_minute

type: object

entities.MessageThread:

properties:

color:

example: indigo

type: string

contact:

example: "+18005550100"

type: string

contact_details:

allOf:

- $ref: '#/definitions/entities.Contact'

description: ContactDetails is resolved at read time and never persisted.

created_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

id:

example: 32343a19-da5e-4b1b-a767-3298a73703ca

type: string

is_archived:

example: false

type: boolean

last_message_content:

example: This is a sample message content

type: string

last_message_id:

example: 32343a19-da5e-4b1b-a767-3298a73703ca

type: string

order_timestamp:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

owner:

example: "+18005550199"

type: string

status:

example: PENDING

type: string

unread_count:

example: 0

type: integer

updated_at:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

required:

- color

- contact

- created_at

- id

- is_archived

- last_message_content

- last_message_id

- order_timestamp

- owner

- status

- unread_count

- updated_at

- user_id

type: object

entities.Phone:

properties:

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

fcm_token:

example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd.....

type: string

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

max_send_attempts:

description: MaxSendAttempts determines how many times to retry sending an

SMS message

example: 2

type: integer

message_expiration_seconds:

description: MessageExpirationSeconds is the duration in seconds after sending

a message when it is considered to be expired.

type: integer

message_send_schedule_id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

messages_per_minute:

example: 1

type: integer

missed_call_auto_reply:

example: This phone cannot receive calls. Please send an SMS instead.

type: string

phone_number:

example: "+18005550199"

type: string

sim:

$ref: '#/definitions/entities.SIM'

unarchive_thread:

description: UnarchiveThread moves an archived message thread back to the

inbox when a new message is received on this phone.

example: false

type: boolean

updated_at:

example: "2022-06-05T14:26:10.303278+03:00"

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

required:

- created_at

- id

- max_send_attempts

- message_expiration_seconds

- messages_per_minute

- phone_number

- sim

- unarchive_thread

- updated_at

- user_id

type: object

entities.PhoneAPIKey:

properties:

api_key:

example: pk_DGW8NwQp7mxKaSZ72Xq9v6xxxxx

type: string

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

name:

example: Business Phone Key

type: string

phone_ids:

example:

- 32343a19-da5e-4b1b-a767-3298a73703cb

- 32343a19-da5e-4b1b-a767-3298a73703cc

items:

type: string

type: array

phone_numbers:

example:

- "+18005550199"

- "+18005550100"

items:

type: string

type: array

updated_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

user_email:

example: user@gmail.com

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

required:

- api_key

- created_at

- id

- name

- phone_ids

- phone_numbers

- updated_at

- user_email

- user_id

type: object

entities.SIM:

enum:

- SIM1

- SIM2

type: string

x-enum-varnames:

- SIM1

- SIM2

entities.SubscriptionName:

enum:

- free

- pro-monthly

- pro-yearly

- ultra-monthly

- ultra-yearly

- pro-lifetime

- 20k-monthly

- 100k-monthly

- 50k-monthly

- 200k-monthly

- 20k-yearly

type: string

x-enum-varnames:

- SubscriptionNameFree

- SubscriptionNameProMonthly

- SubscriptionNameProYearly

- SubscriptionNameUltraMonthly

- SubscriptionNameUltraYearly

- SubscriptionNameProLifetime

- SubscriptionName20KMonthly

- SubscriptionName100KMonthly

- SubscriptionName50KMonthly

- SubscriptionName200KMonthly

- SubscriptionName20KYearly

entities.User:

properties:

active_phone_id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

api_key:

example: x-api-key

type: string

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

email:

example: name@email.com

type: string

id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

notification_heartbeat_enabled:

example: true

type: boolean

notification_message_status_enabled:

example: true

type: boolean

notification_newsletter_enabled:

example: true

type: boolean

notification_webhook_enabled:

example: true

type: boolean

subscription_ends_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

subscription_id:

example: 8f9c71b8-b84e-4417-8408-a62274f65a08

type: string

subscription_name:

allOf:

- $ref: '#/definitions/entities.SubscriptionName'

example: free

subscription_renews_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

subscription_status:

example: on_trial

type: string

timezone:

example: Europe/Helsinki

type: string

updated_at:

example: "2022-06-05T14:26:10.303278+03:00"

type: string

required:

- api_key

- created_at

- email

- id

- notification_heartbeat_enabled

- notification_message_status_enabled

- notification_newsletter_enabled

- notification_webhook_enabled

- subscription_id

- subscription_name

- timezone

- updated_at

type: object

entities.Webhook:

properties:

created_at:

example: "2022-06-05T14:26:02.302718+03:00"

type: string

events:

example:

- message.phone.received

items:

type: string

type: array

id:

example: 32343a19-da5e-4b1b-a767-3298a73703cb

type: string

phone_numbers:

example:

- "+18005550199"

- "+18005550100"

items:

type: string

type: array

signing_key:

example: DGW8NwQp7mxKaSZ72Xq9v67SLqSbWQvckzzmK8D6rvd7NywSEkdMJtuxKyEkYnCY

type: string

updated_at:

example: "2022-06-05T14:26:10.303278+03:00"

type: string

url:

example: https://example.com

type: string

user_id:

example: WB7DRDWrJZRGbYrv2CKGkqbzvqdC

type: string

required:

- created_at

- events

- id

- phone_numbers

- signing_key

- updated_at

- url

- user_id

type: object

requests.ContactItem:

properties:

emails:

items:

type: string

type: array

name:

example: Alice Smith

type: string

phone_numbers:

items:

type: string

type: array

properties:

additionalProperties:

type: string

type: object

required:

- name

- phone_numbers

type: object

requests.ContactStoreRequest:

properties:

contacts:

items:

$ref: '#/definitions/requests.ContactItem'

type: array

required:

- contacts

type: object

requests.ContactUpdateRequest:

properties:

emails:

items:

type: string

type: array

name:

example: Alice Smith

type: string

phone_numbers:

items:

type: string

type: array

properties:

additionalProperties:

type: string

type: object

required:

- name

- phone_numbers

type: object

requests.DiscordStore:

properties:

incoming_channel_id:

type: string

name:

type: string

server_id:

type: string

required:

- incoming_channel_id

- name

- server_id

type: object

requests.DiscordUpdate:

properties:

incoming_channel_id:

type: string

name:

type: string

server_id:

type: string

required:

- incoming_channel_id

- name

- server_id

type: object

requests.HeartbeatStore:

properties:

charging:

type: boolean

phone_numbers:

items:

type: string

type: array

required:

- charging

- phone_numbers

type: object

requests.MessageAttachment:

properties:

content:

description: Content is the base64-encoded attachment data

example: base64data...

type: string

content_type:

description: ContentType is the MIME type of the attachment

example: image/jpeg

type: string

name:

description: Name is the original filename of the attachment

example: photo.jpg

type: string

required:

- content

- content_type

- name

type: object

requests.MessageBulkSend:

properties:

attachments:

description: Attachments are optional. When you provide a list of attachments,

the message will be sent out as an MMS

items:

type: string

type: array

content:

example: This is a sample text message

type: string

encrypted:

description: Encrypted is used to determine if the content is end-to-end encrypted.

Make sure to set the encryption key on the httpSMS mobile app

example: false

type: boolean

from:

example: "+18005550199"

type: string

request_id:

description: RequestID is an optional parameter used to track a request from

the client's perspective

example: 153554b5-ae44-44a0-8f4f-7bbac5657ad4

type: string

to:

example:

- "+18005550100"

- "+18005550100"

items:

type: string

type: array

required:

- content

- from

- to

type: object

requests.MessageCallMissed:

properties:

from:

example: "+18005550199"

type: string

sim:

example: SIM1

type: string

timestamp:

example: "2022-06-05T14:26:09.527976+03:00"

type: string

to:

example: "+18005550100"

type: string

required:

- from

- sim

- timestamp

- to

type: object

requests.MessageEvent:

properties:

event_name:

description: |-

EventName is the type of event

* SENT: is emitted when a message is sent by the mobile phone

* FAILED: is event is emitted when the message could not be sent by the mobile phone

* DELIVERED: is event is emitted when a delivery report has been received by the mobile phone

example: SENT

type: string

reason:

description: Reason is the exact error message in case the event is an error

type: string

timestamp:

description: Timestamp is the time when the event was emitted, Please send

the timestamp in UTC with as much precision as possible

example: "2022-06-05T14:26:09.527976+03:00"

type: string

required:

- event_name

- reason

- timestamp

type: object

requests.MessageReceive:

properties:

attachments:

description: Attachments is the list of MMS attachments received with the

message

items:

$ref: '#/definitions/requests.MessageAttachment'

type: array

content:

example: This is a sample text message received on a phone

type: string

encrypted:

description: Encrypted is used to determine if the content is end-to-end encrypted.

Make sure to set the encryption key on the httpSMS mobile app

example: false

type: boolean

from:

example: "+18005550199"

type: string

sim:

allOf:

- $ref: '#/definitions/entities.SIM'

description: SIM card that received the message

example: SIM1

timestamp:

description: Timestamp is the time when the event was emitted, Please send

the timestamp in UTC with as much precision as possible

example: "2022-06-05T14:26:09.527976+03:00"

type: string

to:

example: "+18005550100"

type: string

required:

- content

- encrypted

- from

- sim

- timestamp

- to

type: object

requests.MessageSend:

properties:

attachments:

description: Attachments are optional. When you provide a list of attachments,

the message will be sent out as an MMS

example:

- https://example.com/image.jpg

- https://example.com/video.mp4

items:

type: string

type: array

content:

example: This is a sample text message

type: string

encrypted:

description: Encrypted is an optional parameter used to determine if the content

is end-to-end encrypted. Make sure to set the encryption key on the httpSMS

mobile app

example: false

type: boolean

from:

example: "+18005550199"

type: string

request_id:

description: RequestID is an optional parameter used to track a request from

the client's perspective

example: 153554b5-ae44-44a0-8f4f-7bbac5657ad4

type: string

send_at:

description: SendAt is an optional parameter used to schedule a message to

be sent in the future. The time is considered to be in your profile's local

timezone and you can queue messages for up to 20 days (480 hours) in the

future.

example: "2025-12-19T16:39:57-08:00"

type: string

to:

example: "+18005550100"

type: string

required:

- content

- from

- to

type: object

requests.MessageSendScheduleStore:

properties:

name:

type: string

timezone:

type: string

windows:

items:

$ref: '#/definitions/requests.MessageSendScheduleWindow'

type: array

required:

- name

- timezone

- windows

type: object

requests.MessageSendScheduleWindow:

properties:

day_of_week:

type: integer

end_minute:

type: integer

start_minute:

type: integer

required:

- day_of_week

- end_minute

- start_minute

type: object

requests.MessageThreadUpdate:

properties:

is_archived:

example: true

type: boolean

unread_count:

example: 0

type: integer

type: object

requests.PhoneAPIKeyStoreRequest:

properties:

name:

example: My Phone API Key

type: string

required:

- name

type: object

requests.PhoneFCMToken:

properties:

fcm_token:

description: FcmToken is either a Firebase registration token or a public

HTTPS adapter callback URL.

example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd.....

type: string

phone_number:

example: '[+18005550199]'

type: string

sim:

description: SIM is the SIM slot of the phone in case the phone has more than

1 SIM slot

example: SIM1

type: string

required:

- fcm_token

- phone_number

- sim

type: object

requests.PhoneUpsert:

properties:

fcm_token:

description: FcmToken is either a Firebase registration token or a public

HTTPS adapter callback URL.

example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd.....

type: string

max_send_attempts:

description: MaxSendAttempts is the number of attempts when sending an SMS

message to handle the case where the phone is offline.