You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**source** | **str** | Sender ID for the message which will be displayed to the receiver. It should specification E.164 with international calling codes but without the `+` in front. - When sending a message to US/Canada, the Sender ID must be a number which belongs to your Karix Subaccount (or main account). |
6
+
**source** | **str** | Sender ID for the message which will be displayed to the receiver. It should specification E.164 with international calling codes. - When sending a message to US/Canada, the Sender ID must be a number which belongs to your Karix Subaccount (or main account). |
7
7
**destination** | **list[str]** | The destination numbers for the message. |
8
8
**text** | **str** | |
9
9
**notification_url** | **str** | URL on which message status change notifications will be sent | [optional]
Copy file name to clipboardExpand all lines: docs/MessageApi.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -132,7 +132,7 @@ Name | Type | Description | Notes
132
132
133
133
Send a message to a list of phone numbers
134
134
135
-
Send a message to a list of destinations. - A successful `202` response means that a message record has been created in Karix. It does not mean that each message was successfully `queued`, `sent` or `delivered`. - To know the status of the message check the parameter `status` of the message record. - Message records might be created with a `failed` state due issues with Karix or validation issues. Please check `error` to know the reason of the failure. No balance is deducted and `total_cost` is always zero for such cases. - Message records might be updated to state `undelivered`. This is due to carrier/operator related issues. Please check `error` to know the reason of the failure. Balance is still deducted for such cases. - Since this is a bulk API the response structure follows the List Response format rather than the Single Response format. - Once queued, the messages for your account are dequeued and processed at a rate set for your account (defaults to 5 messages per second). Contact [sales]([email protected]) to get your rate limit increased. - For fair usage, there is no rate limiting for queueing messages using this API. Dequeue rate would still be applicable as stated.
135
+
Send a message to a list of destinations. - A successful `202` response means that a message record has been created in Karix. It does not mean that each message was successfully `queued`, `sent` or `delivered`. - To know the status of the message check the parameter `status` of the message record. - Message records might be created with a `failed` state due issues with Karix or validation issues. Please check `error` to know the reason of the failure. No balance is deducted and `total_cost` is always zero for such cases. - Message records might be updated to state `undelivered`. This is due to carrier/operator related issues. Please check `error` to know the reason of the failure. Balance is still deducted for such cases. - Since this is a bulk API the response structure follows the List Response format rather than the Single Response format. - Once queued, the messages for your account are dequeued and processed at a rate set for your account (defaults to 5 messages per second). Contact [sales]([email protected]) to get your rate limit increased. - For fair usage, there is no rate limiting for queueing messages using this API. Dequeue rate would still be applicable as stated.
Edit details of your account or its subaccount - An account can only change the status of subaccounts under it. It cant change its own status - A parent account can edit its own details and the details of its subaccounts # noqa: E501
345
345
This method makes a synchronous HTTP request by default. To make an
Edit details of your account or its subaccount - An account can only change the status of subaccounts under it. It cant change its own status - A parent account can edit its own details and the details of its subaccounts # noqa: E501
369
369
This method makes a synchronous HTTP request by default. To make an
0 commit comments