late-sdk 0.0.43 → 0.0.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +124 -0
- data/docs/AddWhatsAppBroadcastRecipients200Response.md +24 -0
- data/docs/AddWhatsAppBroadcastRecipientsRequest.md +18 -0
- data/docs/AddWhatsAppBroadcastRecipientsRequestRecipientsInner.md +22 -0
- data/docs/BulkDeleteWhatsAppContacts200Response.md +20 -0
- data/docs/BulkDeleteWhatsAppContactsRequest.md +18 -0
- data/docs/BulkUpdateWhatsAppContacts200Response.md +24 -0
- data/docs/BulkUpdateWhatsAppContactsRequest.md +24 -0
- data/docs/CancelWhatsAppBroadcastSchedule200Response.md +22 -0
- data/docs/CancelWhatsAppBroadcastSchedule200ResponseBroadcast.md +20 -0
- data/docs/CreateWhatsAppBroadcast200Response.md +20 -0
- data/docs/CreateWhatsAppBroadcast200ResponseBroadcast.md +30 -0
- data/docs/CreateWhatsAppBroadcastRequest.md +26 -0
- data/docs/CreateWhatsAppBroadcastRequestRecipientsInner.md +22 -0
- data/docs/CreateWhatsAppContact200Response.md +20 -0
- data/docs/CreateWhatsAppContact200ResponseContact.md +34 -0
- data/docs/CreateWhatsAppContactRequest.md +36 -0
- data/docs/CreateWhatsAppTemplate200Response.md +20 -0
- data/docs/CreateWhatsAppTemplate200ResponseTemplate.md +26 -0
- data/docs/CreateWhatsAppTemplateRequest.md +26 -0
- data/docs/DeleteWhatsAppGroupRequest.md +20 -0
- data/docs/GetPreverifiedWhatsAppNumbers200Response.md +20 -0
- data/docs/GetPreverifiedWhatsAppNumbers200ResponseNumbersInner.md +26 -0
- data/docs/GetWhatsAppBroadcast200Response.md +20 -0
- data/docs/GetWhatsAppBroadcast200ResponseBroadcast.md +46 -0
- data/docs/GetWhatsAppBroadcastRecipients200Response.md +24 -0
- data/docs/GetWhatsAppBroadcastRecipients200ResponseRecipientsInner.md +34 -0
- data/docs/GetWhatsAppBroadcastRecipients200ResponseSummary.md +28 -0
- data/docs/GetWhatsAppBroadcasts200Response.md +22 -0
- data/docs/GetWhatsAppBroadcasts200ResponseBroadcastsInner.md +44 -0
- data/docs/GetWhatsAppBroadcasts200ResponseBroadcastsInnerTemplate.md +20 -0
- data/docs/GetWhatsAppBusinessProfile200Response.md +20 -0
- data/docs/GetWhatsAppBusinessProfile200ResponseBusinessProfile.md +30 -0
- data/docs/GetWhatsAppContact200Response.md +20 -0
- data/docs/GetWhatsAppContact200ResponseContact.md +56 -0
- data/docs/GetWhatsAppContacts200Response.md +24 -0
- data/docs/GetWhatsAppContacts200ResponseContactsInner.md +48 -0
- data/docs/GetWhatsAppContacts200ResponseFilters.md +20 -0
- data/docs/GetWhatsAppContacts200ResponsePagination.md +24 -0
- data/docs/GetWhatsAppGroups200Response.md +22 -0
- data/docs/GetWhatsAppGroups200ResponseGroupsInner.md +22 -0
- data/docs/GetWhatsAppGroups200ResponseSummary.md +22 -0
- data/docs/GetWhatsAppPhoneNumber200Response.md +18 -0
- data/docs/GetWhatsAppPhoneNumber200ResponsePhoneNumber.md +30 -0
- data/docs/GetWhatsAppPhoneNumbers200Response.md +18 -0
- data/docs/GetWhatsAppPhoneNumbers200ResponseNumbersInner.md +34 -0
- data/docs/GetWhatsAppTemplate200Response.md +20 -0
- data/docs/GetWhatsAppTemplate200ResponseTemplate.md +28 -0
- data/docs/GetWhatsAppTemplates200Response.md +20 -0
- data/docs/GetWhatsAppTemplates200ResponseTemplatesInner.md +28 -0
- data/docs/ImportWhatsAppContacts200Response.md +22 -0
- data/docs/ImportWhatsAppContacts200ResponseResultsInner.md +26 -0
- data/docs/ImportWhatsAppContacts200ResponseSummary.md +24 -0
- data/docs/ImportWhatsAppContactsRequest.md +26 -0
- data/docs/ImportWhatsAppContactsRequestContactsInner.md +32 -0
- data/docs/PurchaseWhatsAppPhoneNumber200Response.md +49 -0
- data/docs/PurchaseWhatsAppPhoneNumber200ResponseOneOf.md +20 -0
- data/docs/PurchaseWhatsAppPhoneNumber200ResponseOneOf1.md +20 -0
- data/docs/PurchaseWhatsAppPhoneNumber200ResponseOneOf1PhoneNumber.md +30 -0
- data/docs/PurchaseWhatsAppPhoneNumberRequest.md +18 -0
- data/docs/ReleaseWhatsAppPhoneNumber200Response.md +20 -0
- data/docs/ReleaseWhatsAppPhoneNumber200ResponsePhoneNumber.md +24 -0
- data/docs/RemoveWhatsAppBroadcastRecipients200Response.md +22 -0
- data/docs/RemoveWhatsAppBroadcastRecipientsRequest.md +18 -0
- data/docs/RenameWhatsAppGroup200Response.md +22 -0
- data/docs/RenameWhatsAppGroupRequest.md +22 -0
- data/docs/RequestWhatsAppVerificationCode200Response.md +20 -0
- data/docs/RequestWhatsAppVerificationCodeRequest.md +18 -0
- data/docs/ScheduleWhatsAppBroadcast200Response.md +20 -0
- data/docs/ScheduleWhatsAppBroadcast200ResponseBroadcast.md +22 -0
- data/docs/ScheduleWhatsAppBroadcastRequest.md +18 -0
- data/docs/SearchAvailableWhatsAppNumbers200Response.md +18 -0
- data/docs/SendWhatsAppBroadcast200Response.md +26 -0
- data/docs/SendWhatsAppBulk200Response.md +22 -0
- data/docs/SendWhatsAppBulk200ResponseResultsInner.md +24 -0
- data/docs/SendWhatsAppBulk200ResponseSummary.md +22 -0
- data/docs/SendWhatsAppBulkRequest.md +22 -0
- data/docs/SendWhatsAppBulkRequestRecipientsInner.md +20 -0
- data/docs/SendWhatsAppBulkRequestTemplate.md +22 -0
- data/docs/UpdateWhatsAppBusinessProfileRequest.md +32 -0
- data/docs/UpdateWhatsAppContact200Response.md +20 -0
- data/docs/UpdateWhatsAppContact200ResponseContact.md +40 -0
- data/docs/UpdateWhatsAppContactRequest.md +34 -0
- data/docs/UpdateWhatsAppTemplate200Response.md +20 -0
- data/docs/UpdateWhatsAppTemplate200ResponseTemplate.md +22 -0
- data/docs/UpdateWhatsAppTemplateRequest.md +20 -0
- data/docs/VerifyWhatsAppPhoneNumber200Response.md +22 -0
- data/docs/VerifyWhatsAppPhoneNumberRequest.md +18 -0
- data/docs/WhatsAppApi.md +2081 -0
- data/docs/WhatsAppPhoneNumbersApi.md +585 -0
- data/lib/late-sdk/api/whats_app_api.rb +2021 -0
- data/lib/late-sdk/api/whats_app_phone_numbers_api.rb +564 -0
- data/lib/late-sdk/models/add_whats_app_broadcast_recipients200_response.rb +177 -0
- data/lib/late-sdk/models/add_whats_app_broadcast_recipients_request.rb +176 -0
- data/lib/late-sdk/models/add_whats_app_broadcast_recipients_request_recipients_inner.rb +185 -0
- data/lib/late-sdk/models/bulk_delete_whats_app_contacts200_response.rb +157 -0
- data/lib/late-sdk/models/bulk_delete_whats_app_contacts_request.rb +176 -0
- data/lib/late-sdk/models/bulk_update_whats_app_contacts200_response.rb +176 -0
- data/lib/late-sdk/models/bulk_update_whats_app_contacts_request.rb +251 -0
- data/lib/late-sdk/models/cancel_whats_app_broadcast_schedule200_response.rb +165 -0
- data/lib/late-sdk/models/cancel_whats_app_broadcast_schedule200_response_broadcast.rb +157 -0
- data/lib/late-sdk/models/create_whats_app_broadcast200_response.rb +156 -0
- data/lib/late-sdk/models/create_whats_app_broadcast200_response_broadcast.rb +202 -0
- data/lib/late-sdk/models/create_whats_app_broadcast_request.rb +240 -0
- data/lib/late-sdk/models/create_whats_app_broadcast_request_recipients_inner.rb +186 -0
- data/lib/late-sdk/models/create_whats_app_contact200_response.rb +156 -0
- data/lib/late-sdk/models/create_whats_app_contact200_response_contact.rb +223 -0
- data/lib/late-sdk/models/create_whats_app_contact_request.rb +297 -0
- data/lib/late-sdk/models/create_whats_app_template200_response.rb +156 -0
- data/lib/late-sdk/models/create_whats_app_template200_response_template.rb +183 -0
- data/lib/late-sdk/models/create_whats_app_template_request.rb +310 -0
- data/lib/late-sdk/models/delete_whats_app_group_request.rb +192 -0
- data/lib/late-sdk/models/get_preverified_whats_app_numbers200_response.rb +161 -0
- data/lib/late-sdk/models/get_preverified_whats_app_numbers200_response_numbers_inner.rb +183 -0
- data/lib/late-sdk/models/get_whats_app_broadcast200_response.rb +156 -0
- data/lib/late-sdk/models/get_whats_app_broadcast200_response_broadcast.rb +307 -0
- data/lib/late-sdk/models/get_whats_app_broadcast_recipients200_response.rb +176 -0
- data/lib/late-sdk/models/get_whats_app_broadcast_recipients200_response_recipients_inner.rb +253 -0
- data/lib/late-sdk/models/get_whats_app_broadcast_recipients200_response_summary.rb +192 -0
- data/lib/late-sdk/models/get_whats_app_broadcasts200_response.rb +167 -0
- data/lib/late-sdk/models/get_whats_app_broadcasts200_response_broadcasts_inner.rb +298 -0
- data/lib/late-sdk/models/get_whats_app_broadcasts200_response_broadcasts_inner_template.rb +156 -0
- data/lib/late-sdk/models/get_whats_app_business_profile200_response.rb +156 -0
- data/lib/late-sdk/models/get_whats_app_business_profile200_response_business_profile.rb +225 -0
- data/lib/late-sdk/models/get_whats_app_contact200_response.rb +156 -0
- data/lib/late-sdk/models/get_whats_app_contact200_response_contact.rb +322 -0
- data/lib/late-sdk/models/get_whats_app_contacts200_response.rb +176 -0
- data/lib/late-sdk/models/get_whats_app_contacts200_response_contacts_inner.rb +286 -0
- data/lib/late-sdk/models/get_whats_app_contacts200_response_filters.rb +160 -0
- data/lib/late-sdk/models/get_whats_app_contacts200_response_pagination.rb +174 -0
- data/lib/late-sdk/models/get_whats_app_groups200_response.rb +167 -0
- data/lib/late-sdk/models/get_whats_app_groups200_response_groups_inner.rb +167 -0
- data/lib/late-sdk/models/get_whats_app_groups200_response_summary.rb +165 -0
- data/lib/late-sdk/models/get_whats_app_phone_number200_response.rb +147 -0
- data/lib/late-sdk/models/get_whats_app_phone_number200_response_phone_number.rb +235 -0
- data/lib/late-sdk/models/get_whats_app_phone_numbers200_response.rb +149 -0
- data/lib/late-sdk/models/get_whats_app_phone_numbers200_response_numbers_inner.rb +253 -0
- data/lib/late-sdk/models/get_whats_app_template200_response.rb +156 -0
- data/lib/late-sdk/models/get_whats_app_template200_response_template.rb +194 -0
- data/lib/late-sdk/models/get_whats_app_templates200_response.rb +158 -0
- data/lib/late-sdk/models/get_whats_app_templates200_response_templates_inner.rb +241 -0
- data/lib/late-sdk/models/import_whats_app_contacts200_response.rb +167 -0
- data/lib/late-sdk/models/import_whats_app_contacts200_response_results_inner.rb +183 -0
- data/lib/late-sdk/models/import_whats_app_contacts200_response_summary.rb +174 -0
- data/lib/late-sdk/models/import_whats_app_contacts_request.rb +239 -0
- data/lib/late-sdk/models/import_whats_app_contacts_request_contacts_inner.rb +252 -0
- data/lib/late-sdk/models/purchase_whats_app_phone_number200_response.rb +104 -0
- data/lib/late-sdk/models/purchase_whats_app_phone_number200_response_one_of.rb +157 -0
- data/lib/late-sdk/models/purchase_whats_app_phone_number200_response_one_of1.rb +157 -0
- data/lib/late-sdk/models/purchase_whats_app_phone_number200_response_one_of1_phone_number.rb +201 -0
- data/lib/late-sdk/models/purchase_whats_app_phone_number_request.rb +165 -0
- data/lib/late-sdk/models/release_whats_app_phone_number200_response.rb +156 -0
- data/lib/late-sdk/models/release_whats_app_phone_number200_response_phone_number.rb +175 -0
- data/lib/late-sdk/models/remove_whats_app_broadcast_recipients200_response.rb +167 -0
- data/lib/late-sdk/models/remove_whats_app_broadcast_recipients_request.rb +167 -0
- data/lib/late-sdk/models/rename_whats_app_group200_response.rb +166 -0
- data/lib/late-sdk/models/rename_whats_app_group_request.rb +219 -0
- data/lib/late-sdk/models/request_whats_app_verification_code200_response.rb +190 -0
- data/lib/late-sdk/models/request_whats_app_verification_code_request.rb +184 -0
- data/lib/late-sdk/models/schedule_whats_app_broadcast200_response.rb +156 -0
- data/lib/late-sdk/models/schedule_whats_app_broadcast200_response_broadcast.rb +166 -0
- data/lib/late-sdk/models/schedule_whats_app_broadcast_request.rb +165 -0
- data/lib/late-sdk/models/search_available_whats_app_numbers200_response.rb +149 -0
- data/lib/late-sdk/models/send_whats_app_broadcast200_response.rb +221 -0
- data/lib/late-sdk/models/send_whats_app_bulk200_response.rb +167 -0
- data/lib/late-sdk/models/send_whats_app_bulk200_response_results_inner.rb +174 -0
- data/lib/late-sdk/models/send_whats_app_bulk200_response_summary.rb +165 -0
- data/lib/late-sdk/models/send_whats_app_bulk_request.rb +229 -0
- data/lib/late-sdk/models/send_whats_app_bulk_request_recipients_inner.rb +177 -0
- data/lib/late-sdk/models/send_whats_app_bulk_request_template.rb +204 -0
- data/lib/late-sdk/models/update_whats_app_business_profile_request.rb +294 -0
- data/lib/late-sdk/models/update_whats_app_contact200_response.rb +156 -0
- data/lib/late-sdk/models/update_whats_app_contact200_response_contact.rb +250 -0
- data/lib/late-sdk/models/update_whats_app_contact_request.rb +234 -0
- data/lib/late-sdk/models/update_whats_app_template200_response.rb +156 -0
- data/lib/late-sdk/models/update_whats_app_template200_response_template.rb +165 -0
- data/lib/late-sdk/models/update_whats_app_template_request.rb +194 -0
- data/lib/late-sdk/models/verify_whats_app_phone_number200_response.rb +165 -0
- data/lib/late-sdk/models/verify_whats_app_phone_number_request.rb +165 -0
- data/lib/late-sdk/version.rb +1 -1
- data/lib/late-sdk.rb +89 -0
- data/openapi.yaml +2144 -0
- data/spec/api/whats_app_api_spec.rb +402 -0
- data/spec/api/whats_app_phone_numbers_api_spec.rb +137 -0
- data/spec/models/add_whats_app_broadcast_recipients200_response_spec.rb +54 -0
- data/spec/models/add_whats_app_broadcast_recipients_request_recipients_inner_spec.rb +48 -0
- data/spec/models/add_whats_app_broadcast_recipients_request_spec.rb +36 -0
- data/spec/models/bulk_delete_whats_app_contacts200_response_spec.rb +42 -0
- data/spec/models/bulk_delete_whats_app_contacts_request_spec.rb +36 -0
- data/spec/models/bulk_update_whats_app_contacts200_response_spec.rb +54 -0
- data/spec/models/bulk_update_whats_app_contacts_request_spec.rb +58 -0
- data/spec/models/cancel_whats_app_broadcast_schedule200_response_broadcast_spec.rb +42 -0
- data/spec/models/cancel_whats_app_broadcast_schedule200_response_spec.rb +48 -0
- data/spec/models/create_whats_app_broadcast200_response_broadcast_spec.rb +72 -0
- data/spec/models/create_whats_app_broadcast200_response_spec.rb +42 -0
- data/spec/models/create_whats_app_broadcast_request_recipients_inner_spec.rb +48 -0
- data/spec/models/create_whats_app_broadcast_request_spec.rb +60 -0
- data/spec/models/create_whats_app_contact200_response_contact_spec.rb +84 -0
- data/spec/models/create_whats_app_contact200_response_spec.rb +42 -0
- data/spec/models/create_whats_app_contact_request_spec.rb +90 -0
- data/spec/models/create_whats_app_template200_response_spec.rb +42 -0
- data/spec/models/create_whats_app_template200_response_template_spec.rb +60 -0
- data/spec/models/create_whats_app_template_request_spec.rb +64 -0
- data/spec/models/delete_whats_app_group_request_spec.rb +42 -0
- data/spec/models/get_preverified_whats_app_numbers200_response_numbers_inner_spec.rb +60 -0
- data/spec/models/get_preverified_whats_app_numbers200_response_spec.rb +42 -0
- data/spec/models/get_whats_app_broadcast200_response_broadcast_spec.rb +124 -0
- data/spec/models/get_whats_app_broadcast200_response_spec.rb +42 -0
- data/spec/models/get_whats_app_broadcast_recipients200_response_recipients_inner_spec.rb +88 -0
- data/spec/models/get_whats_app_broadcast_recipients200_response_spec.rb +54 -0
- data/spec/models/get_whats_app_broadcast_recipients200_response_summary_spec.rb +66 -0
- data/spec/models/get_whats_app_broadcasts200_response_broadcasts_inner_spec.rb +118 -0
- data/spec/models/get_whats_app_broadcasts200_response_broadcasts_inner_template_spec.rb +42 -0
- data/spec/models/get_whats_app_broadcasts200_response_spec.rb +48 -0
- data/spec/models/get_whats_app_business_profile200_response_business_profile_spec.rb +72 -0
- data/spec/models/get_whats_app_business_profile200_response_spec.rb +42 -0
- data/spec/models/get_whats_app_contact200_response_contact_spec.rb +150 -0
- data/spec/models/get_whats_app_contact200_response_spec.rb +42 -0
- data/spec/models/get_whats_app_contacts200_response_contacts_inner_spec.rb +126 -0
- data/spec/models/get_whats_app_contacts200_response_filters_spec.rb +42 -0
- data/spec/models/get_whats_app_contacts200_response_pagination_spec.rb +54 -0
- data/spec/models/get_whats_app_contacts200_response_spec.rb +54 -0
- data/spec/models/get_whats_app_groups200_response_groups_inner_spec.rb +48 -0
- data/spec/models/get_whats_app_groups200_response_spec.rb +48 -0
- data/spec/models/get_whats_app_groups200_response_summary_spec.rb +48 -0
- data/spec/models/get_whats_app_phone_number200_response_phone_number_spec.rb +76 -0
- data/spec/models/get_whats_app_phone_number200_response_spec.rb +36 -0
- data/spec/models/get_whats_app_phone_numbers200_response_numbers_inner_spec.rb +88 -0
- data/spec/models/get_whats_app_phone_numbers200_response_spec.rb +36 -0
- data/spec/models/get_whats_app_template200_response_spec.rb +42 -0
- data/spec/models/get_whats_app_template200_response_template_spec.rb +66 -0
- data/spec/models/get_whats_app_templates200_response_spec.rb +42 -0
- data/spec/models/get_whats_app_templates200_response_templates_inner_spec.rb +74 -0
- data/spec/models/import_whats_app_contacts200_response_results_inner_spec.rb +60 -0
- data/spec/models/import_whats_app_contacts200_response_spec.rb +48 -0
- data/spec/models/import_whats_app_contacts200_response_summary_spec.rb +54 -0
- data/spec/models/import_whats_app_contacts_request_contacts_inner_spec.rb +78 -0
- data/spec/models/import_whats_app_contacts_request_spec.rb +60 -0
- data/spec/models/purchase_whats_app_phone_number200_response_one_of1_phone_number_spec.rb +72 -0
- data/spec/models/purchase_whats_app_phone_number200_response_one_of1_spec.rb +42 -0
- data/spec/models/purchase_whats_app_phone_number200_response_one_of_spec.rb +42 -0
- data/spec/models/purchase_whats_app_phone_number200_response_spec.rb +32 -0
- data/spec/models/purchase_whats_app_phone_number_request_spec.rb +36 -0
- data/spec/models/release_whats_app_phone_number200_response_phone_number_spec.rb +54 -0
- data/spec/models/release_whats_app_phone_number200_response_spec.rb +42 -0
- data/spec/models/remove_whats_app_broadcast_recipients200_response_spec.rb +48 -0
- data/spec/models/remove_whats_app_broadcast_recipients_request_spec.rb +36 -0
- data/spec/models/rename_whats_app_group200_response_spec.rb +48 -0
- data/spec/models/rename_whats_app_group_request_spec.rb +48 -0
- data/spec/models/request_whats_app_verification_code200_response_spec.rb +46 -0
- data/spec/models/request_whats_app_verification_code_request_spec.rb +40 -0
- data/spec/models/schedule_whats_app_broadcast200_response_broadcast_spec.rb +48 -0
- data/spec/models/schedule_whats_app_broadcast200_response_spec.rb +42 -0
- data/spec/models/schedule_whats_app_broadcast_request_spec.rb +36 -0
- data/spec/models/search_available_whats_app_numbers200_response_spec.rb +36 -0
- data/spec/models/send_whats_app_broadcast200_response_spec.rb +64 -0
- data/spec/models/send_whats_app_bulk200_response_results_inner_spec.rb +54 -0
- data/spec/models/send_whats_app_bulk200_response_spec.rb +48 -0
- data/spec/models/send_whats_app_bulk200_response_summary_spec.rb +48 -0
- data/spec/models/send_whats_app_bulk_request_recipients_inner_spec.rb +42 -0
- data/spec/models/send_whats_app_bulk_request_spec.rb +48 -0
- data/spec/models/send_whats_app_bulk_request_template_spec.rb +48 -0
- data/spec/models/update_whats_app_business_profile_request_spec.rb +78 -0
- data/spec/models/update_whats_app_contact200_response_contact_spec.rb +102 -0
- data/spec/models/update_whats_app_contact200_response_spec.rb +42 -0
- data/spec/models/update_whats_app_contact_request_spec.rb +84 -0
- data/spec/models/update_whats_app_template200_response_spec.rb +42 -0
- data/spec/models/update_whats_app_template200_response_template_spec.rb +48 -0
- data/spec/models/update_whats_app_template_request_spec.rb +42 -0
- data/spec/models/verify_whats_app_phone_number200_response_spec.rb +48 -0
- data/spec/models/verify_whats_app_phone_number_request_spec.rb +36 -0
- metadata +357 -1
data/docs/WhatsAppApi.md
ADDED
|
@@ -0,0 +1,2081 @@
|
|
|
1
|
+
# Late::WhatsAppApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://getlate.dev/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**add_whats_app_broadcast_recipients**](WhatsAppApi.md#add_whats_app_broadcast_recipients) | **PATCH** /v1/whatsapp/broadcasts/{broadcastId}/recipients | Add recipients |
|
|
8
|
+
| [**bulk_delete_whats_app_contacts**](WhatsAppApi.md#bulk_delete_whats_app_contacts) | **DELETE** /v1/whatsapp/contacts/bulk | Bulk delete contacts |
|
|
9
|
+
| [**bulk_update_whats_app_contacts**](WhatsAppApi.md#bulk_update_whats_app_contacts) | **POST** /v1/whatsapp/contacts/bulk | Bulk update contacts |
|
|
10
|
+
| [**cancel_whats_app_broadcast_schedule**](WhatsAppApi.md#cancel_whats_app_broadcast_schedule) | **DELETE** /v1/whatsapp/broadcasts/{broadcastId}/schedule | Cancel scheduled broadcast |
|
|
11
|
+
| [**create_whats_app_broadcast**](WhatsAppApi.md#create_whats_app_broadcast) | **POST** /v1/whatsapp/broadcasts | Create broadcast |
|
|
12
|
+
| [**create_whats_app_contact**](WhatsAppApi.md#create_whats_app_contact) | **POST** /v1/whatsapp/contacts | Create contact |
|
|
13
|
+
| [**create_whats_app_template**](WhatsAppApi.md#create_whats_app_template) | **POST** /v1/whatsapp/templates | Create template |
|
|
14
|
+
| [**delete_whats_app_broadcast**](WhatsAppApi.md#delete_whats_app_broadcast) | **DELETE** /v1/whatsapp/broadcasts/{broadcastId} | Delete broadcast |
|
|
15
|
+
| [**delete_whats_app_contact**](WhatsAppApi.md#delete_whats_app_contact) | **DELETE** /v1/whatsapp/contacts/{contactId} | Delete contact |
|
|
16
|
+
| [**delete_whats_app_group**](WhatsAppApi.md#delete_whats_app_group) | **DELETE** /v1/whatsapp/groups | Delete group |
|
|
17
|
+
| [**delete_whats_app_template**](WhatsAppApi.md#delete_whats_app_template) | **DELETE** /v1/whatsapp/templates/{templateName} | Delete template |
|
|
18
|
+
| [**get_whats_app_broadcast**](WhatsAppApi.md#get_whats_app_broadcast) | **GET** /v1/whatsapp/broadcasts/{broadcastId} | Get broadcast |
|
|
19
|
+
| [**get_whats_app_broadcast_recipients**](WhatsAppApi.md#get_whats_app_broadcast_recipients) | **GET** /v1/whatsapp/broadcasts/{broadcastId}/recipients | List recipients |
|
|
20
|
+
| [**get_whats_app_broadcasts**](WhatsAppApi.md#get_whats_app_broadcasts) | **GET** /v1/whatsapp/broadcasts | List broadcasts |
|
|
21
|
+
| [**get_whats_app_business_profile**](WhatsAppApi.md#get_whats_app_business_profile) | **GET** /v1/whatsapp/business-profile | Get business profile |
|
|
22
|
+
| [**get_whats_app_contact**](WhatsAppApi.md#get_whats_app_contact) | **GET** /v1/whatsapp/contacts/{contactId} | Get contact |
|
|
23
|
+
| [**get_whats_app_contacts**](WhatsAppApi.md#get_whats_app_contacts) | **GET** /v1/whatsapp/contacts | List contacts |
|
|
24
|
+
| [**get_whats_app_groups**](WhatsAppApi.md#get_whats_app_groups) | **GET** /v1/whatsapp/groups | List contact groups |
|
|
25
|
+
| [**get_whats_app_template**](WhatsAppApi.md#get_whats_app_template) | **GET** /v1/whatsapp/templates/{templateName} | Get template |
|
|
26
|
+
| [**get_whats_app_templates**](WhatsAppApi.md#get_whats_app_templates) | **GET** /v1/whatsapp/templates | List templates |
|
|
27
|
+
| [**import_whats_app_contacts**](WhatsAppApi.md#import_whats_app_contacts) | **POST** /v1/whatsapp/contacts/import | Bulk import contacts |
|
|
28
|
+
| [**remove_whats_app_broadcast_recipients**](WhatsAppApi.md#remove_whats_app_broadcast_recipients) | **DELETE** /v1/whatsapp/broadcasts/{broadcastId}/recipients | Remove recipients |
|
|
29
|
+
| [**rename_whats_app_group**](WhatsAppApi.md#rename_whats_app_group) | **POST** /v1/whatsapp/groups | Rename group |
|
|
30
|
+
| [**schedule_whats_app_broadcast**](WhatsAppApi.md#schedule_whats_app_broadcast) | **POST** /v1/whatsapp/broadcasts/{broadcastId}/schedule | Schedule broadcast |
|
|
31
|
+
| [**send_whats_app_broadcast**](WhatsAppApi.md#send_whats_app_broadcast) | **POST** /v1/whatsapp/broadcasts/{broadcastId}/send | Send broadcast |
|
|
32
|
+
| [**send_whats_app_bulk**](WhatsAppApi.md#send_whats_app_bulk) | **POST** /v1/whatsapp/bulk | Bulk send template messages |
|
|
33
|
+
| [**update_whats_app_business_profile**](WhatsAppApi.md#update_whats_app_business_profile) | **POST** /v1/whatsapp/business-profile | Update business profile |
|
|
34
|
+
| [**update_whats_app_contact**](WhatsAppApi.md#update_whats_app_contact) | **PUT** /v1/whatsapp/contacts/{contactId} | Update contact |
|
|
35
|
+
| [**update_whats_app_template**](WhatsAppApi.md#update_whats_app_template) | **PATCH** /v1/whatsapp/templates/{templateName} | Update template |
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## add_whats_app_broadcast_recipients
|
|
39
|
+
|
|
40
|
+
> <AddWhatsAppBroadcastRecipients200Response> add_whats_app_broadcast_recipients(broadcast_id, add_whats_app_broadcast_recipients_request)
|
|
41
|
+
|
|
42
|
+
Add recipients
|
|
43
|
+
|
|
44
|
+
Add recipients to a draft broadcast. Maximum 1000 recipients per request. Duplicate phone numbers are automatically skipped.
|
|
45
|
+
|
|
46
|
+
### Examples
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
require 'time'
|
|
50
|
+
require 'late-sdk'
|
|
51
|
+
# setup authorization
|
|
52
|
+
Late.configure do |config|
|
|
53
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
54
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
api_instance = Late::WhatsAppApi.new
|
|
58
|
+
broadcast_id = 'broadcast_id_example' # String | Broadcast ID
|
|
59
|
+
add_whats_app_broadcast_recipients_request = Late::AddWhatsAppBroadcastRecipientsRequest.new({recipients: [Late::AddWhatsAppBroadcastRecipientsRequestRecipientsInner.new({phone: 'phone_example'})]}) # AddWhatsAppBroadcastRecipientsRequest |
|
|
60
|
+
|
|
61
|
+
begin
|
|
62
|
+
# Add recipients
|
|
63
|
+
result = api_instance.add_whats_app_broadcast_recipients(broadcast_id, add_whats_app_broadcast_recipients_request)
|
|
64
|
+
p result
|
|
65
|
+
rescue Late::ApiError => e
|
|
66
|
+
puts "Error when calling WhatsAppApi->add_whats_app_broadcast_recipients: #{e}"
|
|
67
|
+
end
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
#### Using the add_whats_app_broadcast_recipients_with_http_info variant
|
|
71
|
+
|
|
72
|
+
This returns an Array which contains the response data, status code and headers.
|
|
73
|
+
|
|
74
|
+
> <Array(<AddWhatsAppBroadcastRecipients200Response>, Integer, Hash)> add_whats_app_broadcast_recipients_with_http_info(broadcast_id, add_whats_app_broadcast_recipients_request)
|
|
75
|
+
|
|
76
|
+
```ruby
|
|
77
|
+
begin
|
|
78
|
+
# Add recipients
|
|
79
|
+
data, status_code, headers = api_instance.add_whats_app_broadcast_recipients_with_http_info(broadcast_id, add_whats_app_broadcast_recipients_request)
|
|
80
|
+
p status_code # => 2xx
|
|
81
|
+
p headers # => { ... }
|
|
82
|
+
p data # => <AddWhatsAppBroadcastRecipients200Response>
|
|
83
|
+
rescue Late::ApiError => e
|
|
84
|
+
puts "Error when calling WhatsAppApi->add_whats_app_broadcast_recipients_with_http_info: #{e}"
|
|
85
|
+
end
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Parameters
|
|
89
|
+
|
|
90
|
+
| Name | Type | Description | Notes |
|
|
91
|
+
| ---- | ---- | ----------- | ----- |
|
|
92
|
+
| **broadcast_id** | **String** | Broadcast ID | |
|
|
93
|
+
| **add_whats_app_broadcast_recipients_request** | [**AddWhatsAppBroadcastRecipientsRequest**](AddWhatsAppBroadcastRecipientsRequest.md) | | |
|
|
94
|
+
|
|
95
|
+
### Return type
|
|
96
|
+
|
|
97
|
+
[**AddWhatsAppBroadcastRecipients200Response**](AddWhatsAppBroadcastRecipients200Response.md)
|
|
98
|
+
|
|
99
|
+
### Authorization
|
|
100
|
+
|
|
101
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
102
|
+
|
|
103
|
+
### HTTP request headers
|
|
104
|
+
|
|
105
|
+
- **Content-Type**: application/json
|
|
106
|
+
- **Accept**: application/json
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
## bulk_delete_whats_app_contacts
|
|
110
|
+
|
|
111
|
+
> <BulkDeleteWhatsAppContacts200Response> bulk_delete_whats_app_contacts(bulk_delete_whats_app_contacts_request)
|
|
112
|
+
|
|
113
|
+
Bulk delete contacts
|
|
114
|
+
|
|
115
|
+
Permanently delete multiple contacts at once (max 500 per request).
|
|
116
|
+
|
|
117
|
+
### Examples
|
|
118
|
+
|
|
119
|
+
```ruby
|
|
120
|
+
require 'time'
|
|
121
|
+
require 'late-sdk'
|
|
122
|
+
# setup authorization
|
|
123
|
+
Late.configure do |config|
|
|
124
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
125
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
api_instance = Late::WhatsAppApi.new
|
|
129
|
+
bulk_delete_whats_app_contacts_request = Late::BulkDeleteWhatsAppContactsRequest.new({contact_ids: ['contact_ids_example']}) # BulkDeleteWhatsAppContactsRequest |
|
|
130
|
+
|
|
131
|
+
begin
|
|
132
|
+
# Bulk delete contacts
|
|
133
|
+
result = api_instance.bulk_delete_whats_app_contacts(bulk_delete_whats_app_contacts_request)
|
|
134
|
+
p result
|
|
135
|
+
rescue Late::ApiError => e
|
|
136
|
+
puts "Error when calling WhatsAppApi->bulk_delete_whats_app_contacts: #{e}"
|
|
137
|
+
end
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
#### Using the bulk_delete_whats_app_contacts_with_http_info variant
|
|
141
|
+
|
|
142
|
+
This returns an Array which contains the response data, status code and headers.
|
|
143
|
+
|
|
144
|
+
> <Array(<BulkDeleteWhatsAppContacts200Response>, Integer, Hash)> bulk_delete_whats_app_contacts_with_http_info(bulk_delete_whats_app_contacts_request)
|
|
145
|
+
|
|
146
|
+
```ruby
|
|
147
|
+
begin
|
|
148
|
+
# Bulk delete contacts
|
|
149
|
+
data, status_code, headers = api_instance.bulk_delete_whats_app_contacts_with_http_info(bulk_delete_whats_app_contacts_request)
|
|
150
|
+
p status_code # => 2xx
|
|
151
|
+
p headers # => { ... }
|
|
152
|
+
p data # => <BulkDeleteWhatsAppContacts200Response>
|
|
153
|
+
rescue Late::ApiError => e
|
|
154
|
+
puts "Error when calling WhatsAppApi->bulk_delete_whats_app_contacts_with_http_info: #{e}"
|
|
155
|
+
end
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
| Name | Type | Description | Notes |
|
|
161
|
+
| ---- | ---- | ----------- | ----- |
|
|
162
|
+
| **bulk_delete_whats_app_contacts_request** | [**BulkDeleteWhatsAppContactsRequest**](BulkDeleteWhatsAppContactsRequest.md) | | |
|
|
163
|
+
|
|
164
|
+
### Return type
|
|
165
|
+
|
|
166
|
+
[**BulkDeleteWhatsAppContacts200Response**](BulkDeleteWhatsAppContacts200Response.md)
|
|
167
|
+
|
|
168
|
+
### Authorization
|
|
169
|
+
|
|
170
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
171
|
+
|
|
172
|
+
### HTTP request headers
|
|
173
|
+
|
|
174
|
+
- **Content-Type**: application/json
|
|
175
|
+
- **Accept**: application/json
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
## bulk_update_whats_app_contacts
|
|
179
|
+
|
|
180
|
+
> <BulkUpdateWhatsAppContacts200Response> bulk_update_whats_app_contacts(bulk_update_whats_app_contacts_request)
|
|
181
|
+
|
|
182
|
+
Bulk update contacts
|
|
183
|
+
|
|
184
|
+
Perform bulk operations on multiple contacts (max 500 per request). Supported actions: addTags, removeTags, addGroups, removeGroups, optIn, optOut, block, unblock.
|
|
185
|
+
|
|
186
|
+
### Examples
|
|
187
|
+
|
|
188
|
+
```ruby
|
|
189
|
+
require 'time'
|
|
190
|
+
require 'late-sdk'
|
|
191
|
+
# setup authorization
|
|
192
|
+
Late.configure do |config|
|
|
193
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
194
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
api_instance = Late::WhatsAppApi.new
|
|
198
|
+
bulk_update_whats_app_contacts_request = Late::BulkUpdateWhatsAppContactsRequest.new({action: 'addTags', contact_ids: ['contact_ids_example']}) # BulkUpdateWhatsAppContactsRequest |
|
|
199
|
+
|
|
200
|
+
begin
|
|
201
|
+
# Bulk update contacts
|
|
202
|
+
result = api_instance.bulk_update_whats_app_contacts(bulk_update_whats_app_contacts_request)
|
|
203
|
+
p result
|
|
204
|
+
rescue Late::ApiError => e
|
|
205
|
+
puts "Error when calling WhatsAppApi->bulk_update_whats_app_contacts: #{e}"
|
|
206
|
+
end
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
#### Using the bulk_update_whats_app_contacts_with_http_info variant
|
|
210
|
+
|
|
211
|
+
This returns an Array which contains the response data, status code and headers.
|
|
212
|
+
|
|
213
|
+
> <Array(<BulkUpdateWhatsAppContacts200Response>, Integer, Hash)> bulk_update_whats_app_contacts_with_http_info(bulk_update_whats_app_contacts_request)
|
|
214
|
+
|
|
215
|
+
```ruby
|
|
216
|
+
begin
|
|
217
|
+
# Bulk update contacts
|
|
218
|
+
data, status_code, headers = api_instance.bulk_update_whats_app_contacts_with_http_info(bulk_update_whats_app_contacts_request)
|
|
219
|
+
p status_code # => 2xx
|
|
220
|
+
p headers # => { ... }
|
|
221
|
+
p data # => <BulkUpdateWhatsAppContacts200Response>
|
|
222
|
+
rescue Late::ApiError => e
|
|
223
|
+
puts "Error when calling WhatsAppApi->bulk_update_whats_app_contacts_with_http_info: #{e}"
|
|
224
|
+
end
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Parameters
|
|
228
|
+
|
|
229
|
+
| Name | Type | Description | Notes |
|
|
230
|
+
| ---- | ---- | ----------- | ----- |
|
|
231
|
+
| **bulk_update_whats_app_contacts_request** | [**BulkUpdateWhatsAppContactsRequest**](BulkUpdateWhatsAppContactsRequest.md) | | |
|
|
232
|
+
|
|
233
|
+
### Return type
|
|
234
|
+
|
|
235
|
+
[**BulkUpdateWhatsAppContacts200Response**](BulkUpdateWhatsAppContacts200Response.md)
|
|
236
|
+
|
|
237
|
+
### Authorization
|
|
238
|
+
|
|
239
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
240
|
+
|
|
241
|
+
### HTTP request headers
|
|
242
|
+
|
|
243
|
+
- **Content-Type**: application/json
|
|
244
|
+
- **Accept**: application/json
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
## cancel_whats_app_broadcast_schedule
|
|
248
|
+
|
|
249
|
+
> <CancelWhatsAppBroadcastSchedule200Response> cancel_whats_app_broadcast_schedule(broadcast_id)
|
|
250
|
+
|
|
251
|
+
Cancel scheduled broadcast
|
|
252
|
+
|
|
253
|
+
Cancel a scheduled broadcast and return it to draft status. Only broadcasts in scheduled status can be cancelled.
|
|
254
|
+
|
|
255
|
+
### Examples
|
|
256
|
+
|
|
257
|
+
```ruby
|
|
258
|
+
require 'time'
|
|
259
|
+
require 'late-sdk'
|
|
260
|
+
# setup authorization
|
|
261
|
+
Late.configure do |config|
|
|
262
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
263
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
264
|
+
end
|
|
265
|
+
|
|
266
|
+
api_instance = Late::WhatsAppApi.new
|
|
267
|
+
broadcast_id = 'broadcast_id_example' # String | Broadcast ID
|
|
268
|
+
|
|
269
|
+
begin
|
|
270
|
+
# Cancel scheduled broadcast
|
|
271
|
+
result = api_instance.cancel_whats_app_broadcast_schedule(broadcast_id)
|
|
272
|
+
p result
|
|
273
|
+
rescue Late::ApiError => e
|
|
274
|
+
puts "Error when calling WhatsAppApi->cancel_whats_app_broadcast_schedule: #{e}"
|
|
275
|
+
end
|
|
276
|
+
```
|
|
277
|
+
|
|
278
|
+
#### Using the cancel_whats_app_broadcast_schedule_with_http_info variant
|
|
279
|
+
|
|
280
|
+
This returns an Array which contains the response data, status code and headers.
|
|
281
|
+
|
|
282
|
+
> <Array(<CancelWhatsAppBroadcastSchedule200Response>, Integer, Hash)> cancel_whats_app_broadcast_schedule_with_http_info(broadcast_id)
|
|
283
|
+
|
|
284
|
+
```ruby
|
|
285
|
+
begin
|
|
286
|
+
# Cancel scheduled broadcast
|
|
287
|
+
data, status_code, headers = api_instance.cancel_whats_app_broadcast_schedule_with_http_info(broadcast_id)
|
|
288
|
+
p status_code # => 2xx
|
|
289
|
+
p headers # => { ... }
|
|
290
|
+
p data # => <CancelWhatsAppBroadcastSchedule200Response>
|
|
291
|
+
rescue Late::ApiError => e
|
|
292
|
+
puts "Error when calling WhatsAppApi->cancel_whats_app_broadcast_schedule_with_http_info: #{e}"
|
|
293
|
+
end
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
### Parameters
|
|
297
|
+
|
|
298
|
+
| Name | Type | Description | Notes |
|
|
299
|
+
| ---- | ---- | ----------- | ----- |
|
|
300
|
+
| **broadcast_id** | **String** | Broadcast ID | |
|
|
301
|
+
|
|
302
|
+
### Return type
|
|
303
|
+
|
|
304
|
+
[**CancelWhatsAppBroadcastSchedule200Response**](CancelWhatsAppBroadcastSchedule200Response.md)
|
|
305
|
+
|
|
306
|
+
### Authorization
|
|
307
|
+
|
|
308
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
309
|
+
|
|
310
|
+
### HTTP request headers
|
|
311
|
+
|
|
312
|
+
- **Content-Type**: Not defined
|
|
313
|
+
- **Accept**: application/json
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
## create_whats_app_broadcast
|
|
317
|
+
|
|
318
|
+
> <CreateWhatsAppBroadcast200Response> create_whats_app_broadcast(create_whats_app_broadcast_request)
|
|
319
|
+
|
|
320
|
+
Create broadcast
|
|
321
|
+
|
|
322
|
+
Create a new draft broadcast. Optionally include initial recipients. After creation, add recipients and then send or schedule the broadcast.
|
|
323
|
+
|
|
324
|
+
### Examples
|
|
325
|
+
|
|
326
|
+
```ruby
|
|
327
|
+
require 'time'
|
|
328
|
+
require 'late-sdk'
|
|
329
|
+
# setup authorization
|
|
330
|
+
Late.configure do |config|
|
|
331
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
332
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
api_instance = Late::WhatsAppApi.new
|
|
336
|
+
create_whats_app_broadcast_request = Late::CreateWhatsAppBroadcastRequest.new({account_id: 'account_id_example', name: 'name_example', template: Late::SendWhatsAppBulkRequestTemplate.new({name: 'name_example', language: 'language_example'})}) # CreateWhatsAppBroadcastRequest |
|
|
337
|
+
|
|
338
|
+
begin
|
|
339
|
+
# Create broadcast
|
|
340
|
+
result = api_instance.create_whats_app_broadcast(create_whats_app_broadcast_request)
|
|
341
|
+
p result
|
|
342
|
+
rescue Late::ApiError => e
|
|
343
|
+
puts "Error when calling WhatsAppApi->create_whats_app_broadcast: #{e}"
|
|
344
|
+
end
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
#### Using the create_whats_app_broadcast_with_http_info variant
|
|
348
|
+
|
|
349
|
+
This returns an Array which contains the response data, status code and headers.
|
|
350
|
+
|
|
351
|
+
> <Array(<CreateWhatsAppBroadcast200Response>, Integer, Hash)> create_whats_app_broadcast_with_http_info(create_whats_app_broadcast_request)
|
|
352
|
+
|
|
353
|
+
```ruby
|
|
354
|
+
begin
|
|
355
|
+
# Create broadcast
|
|
356
|
+
data, status_code, headers = api_instance.create_whats_app_broadcast_with_http_info(create_whats_app_broadcast_request)
|
|
357
|
+
p status_code # => 2xx
|
|
358
|
+
p headers # => { ... }
|
|
359
|
+
p data # => <CreateWhatsAppBroadcast200Response>
|
|
360
|
+
rescue Late::ApiError => e
|
|
361
|
+
puts "Error when calling WhatsAppApi->create_whats_app_broadcast_with_http_info: #{e}"
|
|
362
|
+
end
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
### Parameters
|
|
366
|
+
|
|
367
|
+
| Name | Type | Description | Notes |
|
|
368
|
+
| ---- | ---- | ----------- | ----- |
|
|
369
|
+
| **create_whats_app_broadcast_request** | [**CreateWhatsAppBroadcastRequest**](CreateWhatsAppBroadcastRequest.md) | | |
|
|
370
|
+
|
|
371
|
+
### Return type
|
|
372
|
+
|
|
373
|
+
[**CreateWhatsAppBroadcast200Response**](CreateWhatsAppBroadcast200Response.md)
|
|
374
|
+
|
|
375
|
+
### Authorization
|
|
376
|
+
|
|
377
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
378
|
+
|
|
379
|
+
### HTTP request headers
|
|
380
|
+
|
|
381
|
+
- **Content-Type**: application/json
|
|
382
|
+
- **Accept**: application/json
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
## create_whats_app_contact
|
|
386
|
+
|
|
387
|
+
> <CreateWhatsAppContact200Response> create_whats_app_contact(create_whats_app_contact_request)
|
|
388
|
+
|
|
389
|
+
Create contact
|
|
390
|
+
|
|
391
|
+
Create a new WhatsApp contact. Phone number must be unique per account and in E.164 format (e.g., +1234567890).
|
|
392
|
+
|
|
393
|
+
### Examples
|
|
394
|
+
|
|
395
|
+
```ruby
|
|
396
|
+
require 'time'
|
|
397
|
+
require 'late-sdk'
|
|
398
|
+
# setup authorization
|
|
399
|
+
Late.configure do |config|
|
|
400
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
401
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
402
|
+
end
|
|
403
|
+
|
|
404
|
+
api_instance = Late::WhatsAppApi.new
|
|
405
|
+
create_whats_app_contact_request = Late::CreateWhatsAppContactRequest.new({account_id: 'account_id_example', phone: 'phone_example', name: 'name_example'}) # CreateWhatsAppContactRequest |
|
|
406
|
+
|
|
407
|
+
begin
|
|
408
|
+
# Create contact
|
|
409
|
+
result = api_instance.create_whats_app_contact(create_whats_app_contact_request)
|
|
410
|
+
p result
|
|
411
|
+
rescue Late::ApiError => e
|
|
412
|
+
puts "Error when calling WhatsAppApi->create_whats_app_contact: #{e}"
|
|
413
|
+
end
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
#### Using the create_whats_app_contact_with_http_info variant
|
|
417
|
+
|
|
418
|
+
This returns an Array which contains the response data, status code and headers.
|
|
419
|
+
|
|
420
|
+
> <Array(<CreateWhatsAppContact200Response>, Integer, Hash)> create_whats_app_contact_with_http_info(create_whats_app_contact_request)
|
|
421
|
+
|
|
422
|
+
```ruby
|
|
423
|
+
begin
|
|
424
|
+
# Create contact
|
|
425
|
+
data, status_code, headers = api_instance.create_whats_app_contact_with_http_info(create_whats_app_contact_request)
|
|
426
|
+
p status_code # => 2xx
|
|
427
|
+
p headers # => { ... }
|
|
428
|
+
p data # => <CreateWhatsAppContact200Response>
|
|
429
|
+
rescue Late::ApiError => e
|
|
430
|
+
puts "Error when calling WhatsAppApi->create_whats_app_contact_with_http_info: #{e}"
|
|
431
|
+
end
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
### Parameters
|
|
435
|
+
|
|
436
|
+
| Name | Type | Description | Notes |
|
|
437
|
+
| ---- | ---- | ----------- | ----- |
|
|
438
|
+
| **create_whats_app_contact_request** | [**CreateWhatsAppContactRequest**](CreateWhatsAppContactRequest.md) | | |
|
|
439
|
+
|
|
440
|
+
### Return type
|
|
441
|
+
|
|
442
|
+
[**CreateWhatsAppContact200Response**](CreateWhatsAppContact200Response.md)
|
|
443
|
+
|
|
444
|
+
### Authorization
|
|
445
|
+
|
|
446
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
447
|
+
|
|
448
|
+
### HTTP request headers
|
|
449
|
+
|
|
450
|
+
- **Content-Type**: application/json
|
|
451
|
+
- **Accept**: application/json
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
## create_whats_app_template
|
|
455
|
+
|
|
456
|
+
> <CreateWhatsAppTemplate200Response> create_whats_app_template(create_whats_app_template_request)
|
|
457
|
+
|
|
458
|
+
Create template
|
|
459
|
+
|
|
460
|
+
Create a new message template. Template names must be lowercase, start with a letter, and contain only letters, numbers, and underscores. Templates are submitted to Meta for review.
|
|
461
|
+
|
|
462
|
+
### Examples
|
|
463
|
+
|
|
464
|
+
```ruby
|
|
465
|
+
require 'time'
|
|
466
|
+
require 'late-sdk'
|
|
467
|
+
# setup authorization
|
|
468
|
+
Late.configure do |config|
|
|
469
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
470
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
471
|
+
end
|
|
472
|
+
|
|
473
|
+
api_instance = Late::WhatsAppApi.new
|
|
474
|
+
create_whats_app_template_request = Late::CreateWhatsAppTemplateRequest.new({account_id: 'account_id_example', name: 'name_example', category: 'AUTHENTICATION', language: 'language_example', components: [3.56]}) # CreateWhatsAppTemplateRequest |
|
|
475
|
+
|
|
476
|
+
begin
|
|
477
|
+
# Create template
|
|
478
|
+
result = api_instance.create_whats_app_template(create_whats_app_template_request)
|
|
479
|
+
p result
|
|
480
|
+
rescue Late::ApiError => e
|
|
481
|
+
puts "Error when calling WhatsAppApi->create_whats_app_template: #{e}"
|
|
482
|
+
end
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
#### Using the create_whats_app_template_with_http_info variant
|
|
486
|
+
|
|
487
|
+
This returns an Array which contains the response data, status code and headers.
|
|
488
|
+
|
|
489
|
+
> <Array(<CreateWhatsAppTemplate200Response>, Integer, Hash)> create_whats_app_template_with_http_info(create_whats_app_template_request)
|
|
490
|
+
|
|
491
|
+
```ruby
|
|
492
|
+
begin
|
|
493
|
+
# Create template
|
|
494
|
+
data, status_code, headers = api_instance.create_whats_app_template_with_http_info(create_whats_app_template_request)
|
|
495
|
+
p status_code # => 2xx
|
|
496
|
+
p headers # => { ... }
|
|
497
|
+
p data # => <CreateWhatsAppTemplate200Response>
|
|
498
|
+
rescue Late::ApiError => e
|
|
499
|
+
puts "Error when calling WhatsAppApi->create_whats_app_template_with_http_info: #{e}"
|
|
500
|
+
end
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
### Parameters
|
|
504
|
+
|
|
505
|
+
| Name | Type | Description | Notes |
|
|
506
|
+
| ---- | ---- | ----------- | ----- |
|
|
507
|
+
| **create_whats_app_template_request** | [**CreateWhatsAppTemplateRequest**](CreateWhatsAppTemplateRequest.md) | | |
|
|
508
|
+
|
|
509
|
+
### Return type
|
|
510
|
+
|
|
511
|
+
[**CreateWhatsAppTemplate200Response**](CreateWhatsAppTemplate200Response.md)
|
|
512
|
+
|
|
513
|
+
### Authorization
|
|
514
|
+
|
|
515
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
516
|
+
|
|
517
|
+
### HTTP request headers
|
|
518
|
+
|
|
519
|
+
- **Content-Type**: application/json
|
|
520
|
+
- **Accept**: application/json
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
## delete_whats_app_broadcast
|
|
524
|
+
|
|
525
|
+
> <UnpublishPost200Response> delete_whats_app_broadcast(broadcast_id)
|
|
526
|
+
|
|
527
|
+
Delete broadcast
|
|
528
|
+
|
|
529
|
+
Delete a broadcast. Only draft or cancelled broadcasts can be deleted.
|
|
530
|
+
|
|
531
|
+
### Examples
|
|
532
|
+
|
|
533
|
+
```ruby
|
|
534
|
+
require 'time'
|
|
535
|
+
require 'late-sdk'
|
|
536
|
+
# setup authorization
|
|
537
|
+
Late.configure do |config|
|
|
538
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
539
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
540
|
+
end
|
|
541
|
+
|
|
542
|
+
api_instance = Late::WhatsAppApi.new
|
|
543
|
+
broadcast_id = 'broadcast_id_example' # String | Broadcast ID
|
|
544
|
+
|
|
545
|
+
begin
|
|
546
|
+
# Delete broadcast
|
|
547
|
+
result = api_instance.delete_whats_app_broadcast(broadcast_id)
|
|
548
|
+
p result
|
|
549
|
+
rescue Late::ApiError => e
|
|
550
|
+
puts "Error when calling WhatsAppApi->delete_whats_app_broadcast: #{e}"
|
|
551
|
+
end
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
#### Using the delete_whats_app_broadcast_with_http_info variant
|
|
555
|
+
|
|
556
|
+
This returns an Array which contains the response data, status code and headers.
|
|
557
|
+
|
|
558
|
+
> <Array(<UnpublishPost200Response>, Integer, Hash)> delete_whats_app_broadcast_with_http_info(broadcast_id)
|
|
559
|
+
|
|
560
|
+
```ruby
|
|
561
|
+
begin
|
|
562
|
+
# Delete broadcast
|
|
563
|
+
data, status_code, headers = api_instance.delete_whats_app_broadcast_with_http_info(broadcast_id)
|
|
564
|
+
p status_code # => 2xx
|
|
565
|
+
p headers # => { ... }
|
|
566
|
+
p data # => <UnpublishPost200Response>
|
|
567
|
+
rescue Late::ApiError => e
|
|
568
|
+
puts "Error when calling WhatsAppApi->delete_whats_app_broadcast_with_http_info: #{e}"
|
|
569
|
+
end
|
|
570
|
+
```
|
|
571
|
+
|
|
572
|
+
### Parameters
|
|
573
|
+
|
|
574
|
+
| Name | Type | Description | Notes |
|
|
575
|
+
| ---- | ---- | ----------- | ----- |
|
|
576
|
+
| **broadcast_id** | **String** | Broadcast ID | |
|
|
577
|
+
|
|
578
|
+
### Return type
|
|
579
|
+
|
|
580
|
+
[**UnpublishPost200Response**](UnpublishPost200Response.md)
|
|
581
|
+
|
|
582
|
+
### Authorization
|
|
583
|
+
|
|
584
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
585
|
+
|
|
586
|
+
### HTTP request headers
|
|
587
|
+
|
|
588
|
+
- **Content-Type**: Not defined
|
|
589
|
+
- **Accept**: application/json
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
## delete_whats_app_contact
|
|
593
|
+
|
|
594
|
+
> <UnpublishPost200Response> delete_whats_app_contact(contact_id)
|
|
595
|
+
|
|
596
|
+
Delete contact
|
|
597
|
+
|
|
598
|
+
Permanently delete a WhatsApp contact.
|
|
599
|
+
|
|
600
|
+
### Examples
|
|
601
|
+
|
|
602
|
+
```ruby
|
|
603
|
+
require 'time'
|
|
604
|
+
require 'late-sdk'
|
|
605
|
+
# setup authorization
|
|
606
|
+
Late.configure do |config|
|
|
607
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
608
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
609
|
+
end
|
|
610
|
+
|
|
611
|
+
api_instance = Late::WhatsAppApi.new
|
|
612
|
+
contact_id = 'contact_id_example' # String | Contact ID
|
|
613
|
+
|
|
614
|
+
begin
|
|
615
|
+
# Delete contact
|
|
616
|
+
result = api_instance.delete_whats_app_contact(contact_id)
|
|
617
|
+
p result
|
|
618
|
+
rescue Late::ApiError => e
|
|
619
|
+
puts "Error when calling WhatsAppApi->delete_whats_app_contact: #{e}"
|
|
620
|
+
end
|
|
621
|
+
```
|
|
622
|
+
|
|
623
|
+
#### Using the delete_whats_app_contact_with_http_info variant
|
|
624
|
+
|
|
625
|
+
This returns an Array which contains the response data, status code and headers.
|
|
626
|
+
|
|
627
|
+
> <Array(<UnpublishPost200Response>, Integer, Hash)> delete_whats_app_contact_with_http_info(contact_id)
|
|
628
|
+
|
|
629
|
+
```ruby
|
|
630
|
+
begin
|
|
631
|
+
# Delete contact
|
|
632
|
+
data, status_code, headers = api_instance.delete_whats_app_contact_with_http_info(contact_id)
|
|
633
|
+
p status_code # => 2xx
|
|
634
|
+
p headers # => { ... }
|
|
635
|
+
p data # => <UnpublishPost200Response>
|
|
636
|
+
rescue Late::ApiError => e
|
|
637
|
+
puts "Error when calling WhatsAppApi->delete_whats_app_contact_with_http_info: #{e}"
|
|
638
|
+
end
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
### Parameters
|
|
642
|
+
|
|
643
|
+
| Name | Type | Description | Notes |
|
|
644
|
+
| ---- | ---- | ----------- | ----- |
|
|
645
|
+
| **contact_id** | **String** | Contact ID | |
|
|
646
|
+
|
|
647
|
+
### Return type
|
|
648
|
+
|
|
649
|
+
[**UnpublishPost200Response**](UnpublishPost200Response.md)
|
|
650
|
+
|
|
651
|
+
### Authorization
|
|
652
|
+
|
|
653
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
654
|
+
|
|
655
|
+
### HTTP request headers
|
|
656
|
+
|
|
657
|
+
- **Content-Type**: Not defined
|
|
658
|
+
- **Accept**: application/json
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
## delete_whats_app_group
|
|
662
|
+
|
|
663
|
+
> <RenameWhatsAppGroup200Response> delete_whats_app_group(delete_whats_app_group_request)
|
|
664
|
+
|
|
665
|
+
Delete group
|
|
666
|
+
|
|
667
|
+
Delete a contact group. This removes the group from all contacts but does not delete the contacts themselves.
|
|
668
|
+
|
|
669
|
+
### Examples
|
|
670
|
+
|
|
671
|
+
```ruby
|
|
672
|
+
require 'time'
|
|
673
|
+
require 'late-sdk'
|
|
674
|
+
# setup authorization
|
|
675
|
+
Late.configure do |config|
|
|
676
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
677
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
678
|
+
end
|
|
679
|
+
|
|
680
|
+
api_instance = Late::WhatsAppApi.new
|
|
681
|
+
delete_whats_app_group_request = Late::DeleteWhatsAppGroupRequest.new({account_id: 'account_id_example', group_name: 'group_name_example'}) # DeleteWhatsAppGroupRequest |
|
|
682
|
+
|
|
683
|
+
begin
|
|
684
|
+
# Delete group
|
|
685
|
+
result = api_instance.delete_whats_app_group(delete_whats_app_group_request)
|
|
686
|
+
p result
|
|
687
|
+
rescue Late::ApiError => e
|
|
688
|
+
puts "Error when calling WhatsAppApi->delete_whats_app_group: #{e}"
|
|
689
|
+
end
|
|
690
|
+
```
|
|
691
|
+
|
|
692
|
+
#### Using the delete_whats_app_group_with_http_info variant
|
|
693
|
+
|
|
694
|
+
This returns an Array which contains the response data, status code and headers.
|
|
695
|
+
|
|
696
|
+
> <Array(<RenameWhatsAppGroup200Response>, Integer, Hash)> delete_whats_app_group_with_http_info(delete_whats_app_group_request)
|
|
697
|
+
|
|
698
|
+
```ruby
|
|
699
|
+
begin
|
|
700
|
+
# Delete group
|
|
701
|
+
data, status_code, headers = api_instance.delete_whats_app_group_with_http_info(delete_whats_app_group_request)
|
|
702
|
+
p status_code # => 2xx
|
|
703
|
+
p headers # => { ... }
|
|
704
|
+
p data # => <RenameWhatsAppGroup200Response>
|
|
705
|
+
rescue Late::ApiError => e
|
|
706
|
+
puts "Error when calling WhatsAppApi->delete_whats_app_group_with_http_info: #{e}"
|
|
707
|
+
end
|
|
708
|
+
```
|
|
709
|
+
|
|
710
|
+
### Parameters
|
|
711
|
+
|
|
712
|
+
| Name | Type | Description | Notes |
|
|
713
|
+
| ---- | ---- | ----------- | ----- |
|
|
714
|
+
| **delete_whats_app_group_request** | [**DeleteWhatsAppGroupRequest**](DeleteWhatsAppGroupRequest.md) | | |
|
|
715
|
+
|
|
716
|
+
### Return type
|
|
717
|
+
|
|
718
|
+
[**RenameWhatsAppGroup200Response**](RenameWhatsAppGroup200Response.md)
|
|
719
|
+
|
|
720
|
+
### Authorization
|
|
721
|
+
|
|
722
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
723
|
+
|
|
724
|
+
### HTTP request headers
|
|
725
|
+
|
|
726
|
+
- **Content-Type**: application/json
|
|
727
|
+
- **Accept**: application/json
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
## delete_whats_app_template
|
|
731
|
+
|
|
732
|
+
> <UnpublishPost200Response> delete_whats_app_template(template_name, account_id)
|
|
733
|
+
|
|
734
|
+
Delete template
|
|
735
|
+
|
|
736
|
+
Permanently delete a message template by name.
|
|
737
|
+
|
|
738
|
+
### Examples
|
|
739
|
+
|
|
740
|
+
```ruby
|
|
741
|
+
require 'time'
|
|
742
|
+
require 'late-sdk'
|
|
743
|
+
# setup authorization
|
|
744
|
+
Late.configure do |config|
|
|
745
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
746
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
747
|
+
end
|
|
748
|
+
|
|
749
|
+
api_instance = Late::WhatsAppApi.new
|
|
750
|
+
template_name = 'template_name_example' # String | Template name
|
|
751
|
+
account_id = 'account_id_example' # String | WhatsApp social account ID
|
|
752
|
+
|
|
753
|
+
begin
|
|
754
|
+
# Delete template
|
|
755
|
+
result = api_instance.delete_whats_app_template(template_name, account_id)
|
|
756
|
+
p result
|
|
757
|
+
rescue Late::ApiError => e
|
|
758
|
+
puts "Error when calling WhatsAppApi->delete_whats_app_template: #{e}"
|
|
759
|
+
end
|
|
760
|
+
```
|
|
761
|
+
|
|
762
|
+
#### Using the delete_whats_app_template_with_http_info variant
|
|
763
|
+
|
|
764
|
+
This returns an Array which contains the response data, status code and headers.
|
|
765
|
+
|
|
766
|
+
> <Array(<UnpublishPost200Response>, Integer, Hash)> delete_whats_app_template_with_http_info(template_name, account_id)
|
|
767
|
+
|
|
768
|
+
```ruby
|
|
769
|
+
begin
|
|
770
|
+
# Delete template
|
|
771
|
+
data, status_code, headers = api_instance.delete_whats_app_template_with_http_info(template_name, account_id)
|
|
772
|
+
p status_code # => 2xx
|
|
773
|
+
p headers # => { ... }
|
|
774
|
+
p data # => <UnpublishPost200Response>
|
|
775
|
+
rescue Late::ApiError => e
|
|
776
|
+
puts "Error when calling WhatsAppApi->delete_whats_app_template_with_http_info: #{e}"
|
|
777
|
+
end
|
|
778
|
+
```
|
|
779
|
+
|
|
780
|
+
### Parameters
|
|
781
|
+
|
|
782
|
+
| Name | Type | Description | Notes |
|
|
783
|
+
| ---- | ---- | ----------- | ----- |
|
|
784
|
+
| **template_name** | **String** | Template name | |
|
|
785
|
+
| **account_id** | **String** | WhatsApp social account ID | |
|
|
786
|
+
|
|
787
|
+
### Return type
|
|
788
|
+
|
|
789
|
+
[**UnpublishPost200Response**](UnpublishPost200Response.md)
|
|
790
|
+
|
|
791
|
+
### Authorization
|
|
792
|
+
|
|
793
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
794
|
+
|
|
795
|
+
### HTTP request headers
|
|
796
|
+
|
|
797
|
+
- **Content-Type**: Not defined
|
|
798
|
+
- **Accept**: application/json
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
## get_whats_app_broadcast
|
|
802
|
+
|
|
803
|
+
> <GetWhatsAppBroadcast200Response> get_whats_app_broadcast(broadcast_id)
|
|
804
|
+
|
|
805
|
+
Get broadcast
|
|
806
|
+
|
|
807
|
+
Retrieve detailed information about a single broadcast including delivery statistics.
|
|
808
|
+
|
|
809
|
+
### Examples
|
|
810
|
+
|
|
811
|
+
```ruby
|
|
812
|
+
require 'time'
|
|
813
|
+
require 'late-sdk'
|
|
814
|
+
# setup authorization
|
|
815
|
+
Late.configure do |config|
|
|
816
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
817
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
818
|
+
end
|
|
819
|
+
|
|
820
|
+
api_instance = Late::WhatsAppApi.new
|
|
821
|
+
broadcast_id = 'broadcast_id_example' # String | Broadcast ID
|
|
822
|
+
|
|
823
|
+
begin
|
|
824
|
+
# Get broadcast
|
|
825
|
+
result = api_instance.get_whats_app_broadcast(broadcast_id)
|
|
826
|
+
p result
|
|
827
|
+
rescue Late::ApiError => e
|
|
828
|
+
puts "Error when calling WhatsAppApi->get_whats_app_broadcast: #{e}"
|
|
829
|
+
end
|
|
830
|
+
```
|
|
831
|
+
|
|
832
|
+
#### Using the get_whats_app_broadcast_with_http_info variant
|
|
833
|
+
|
|
834
|
+
This returns an Array which contains the response data, status code and headers.
|
|
835
|
+
|
|
836
|
+
> <Array(<GetWhatsAppBroadcast200Response>, Integer, Hash)> get_whats_app_broadcast_with_http_info(broadcast_id)
|
|
837
|
+
|
|
838
|
+
```ruby
|
|
839
|
+
begin
|
|
840
|
+
# Get broadcast
|
|
841
|
+
data, status_code, headers = api_instance.get_whats_app_broadcast_with_http_info(broadcast_id)
|
|
842
|
+
p status_code # => 2xx
|
|
843
|
+
p headers # => { ... }
|
|
844
|
+
p data # => <GetWhatsAppBroadcast200Response>
|
|
845
|
+
rescue Late::ApiError => e
|
|
846
|
+
puts "Error when calling WhatsAppApi->get_whats_app_broadcast_with_http_info: #{e}"
|
|
847
|
+
end
|
|
848
|
+
```
|
|
849
|
+
|
|
850
|
+
### Parameters
|
|
851
|
+
|
|
852
|
+
| Name | Type | Description | Notes |
|
|
853
|
+
| ---- | ---- | ----------- | ----- |
|
|
854
|
+
| **broadcast_id** | **String** | Broadcast ID | |
|
|
855
|
+
|
|
856
|
+
### Return type
|
|
857
|
+
|
|
858
|
+
[**GetWhatsAppBroadcast200Response**](GetWhatsAppBroadcast200Response.md)
|
|
859
|
+
|
|
860
|
+
### Authorization
|
|
861
|
+
|
|
862
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
863
|
+
|
|
864
|
+
### HTTP request headers
|
|
865
|
+
|
|
866
|
+
- **Content-Type**: Not defined
|
|
867
|
+
- **Accept**: application/json
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
## get_whats_app_broadcast_recipients
|
|
871
|
+
|
|
872
|
+
> <GetWhatsAppBroadcastRecipients200Response> get_whats_app_broadcast_recipients(broadcast_id, opts)
|
|
873
|
+
|
|
874
|
+
List recipients
|
|
875
|
+
|
|
876
|
+
List recipients of a broadcast with their delivery status. Supports filtering by delivery status and pagination.
|
|
877
|
+
|
|
878
|
+
### Examples
|
|
879
|
+
|
|
880
|
+
```ruby
|
|
881
|
+
require 'time'
|
|
882
|
+
require 'late-sdk'
|
|
883
|
+
# setup authorization
|
|
884
|
+
Late.configure do |config|
|
|
885
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
886
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
887
|
+
end
|
|
888
|
+
|
|
889
|
+
api_instance = Late::WhatsAppApi.new
|
|
890
|
+
broadcast_id = 'broadcast_id_example' # String | Broadcast ID
|
|
891
|
+
opts = {
|
|
892
|
+
status: 'pending', # String | Filter by recipient delivery status
|
|
893
|
+
limit: 56, # Integer | Maximum results (default 100)
|
|
894
|
+
skip: 56 # Integer | Offset for pagination
|
|
895
|
+
}
|
|
896
|
+
|
|
897
|
+
begin
|
|
898
|
+
# List recipients
|
|
899
|
+
result = api_instance.get_whats_app_broadcast_recipients(broadcast_id, opts)
|
|
900
|
+
p result
|
|
901
|
+
rescue Late::ApiError => e
|
|
902
|
+
puts "Error when calling WhatsAppApi->get_whats_app_broadcast_recipients: #{e}"
|
|
903
|
+
end
|
|
904
|
+
```
|
|
905
|
+
|
|
906
|
+
#### Using the get_whats_app_broadcast_recipients_with_http_info variant
|
|
907
|
+
|
|
908
|
+
This returns an Array which contains the response data, status code and headers.
|
|
909
|
+
|
|
910
|
+
> <Array(<GetWhatsAppBroadcastRecipients200Response>, Integer, Hash)> get_whats_app_broadcast_recipients_with_http_info(broadcast_id, opts)
|
|
911
|
+
|
|
912
|
+
```ruby
|
|
913
|
+
begin
|
|
914
|
+
# List recipients
|
|
915
|
+
data, status_code, headers = api_instance.get_whats_app_broadcast_recipients_with_http_info(broadcast_id, opts)
|
|
916
|
+
p status_code # => 2xx
|
|
917
|
+
p headers # => { ... }
|
|
918
|
+
p data # => <GetWhatsAppBroadcastRecipients200Response>
|
|
919
|
+
rescue Late::ApiError => e
|
|
920
|
+
puts "Error when calling WhatsAppApi->get_whats_app_broadcast_recipients_with_http_info: #{e}"
|
|
921
|
+
end
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
### Parameters
|
|
925
|
+
|
|
926
|
+
| Name | Type | Description | Notes |
|
|
927
|
+
| ---- | ---- | ----------- | ----- |
|
|
928
|
+
| **broadcast_id** | **String** | Broadcast ID | |
|
|
929
|
+
| **status** | **String** | Filter by recipient delivery status | [optional] |
|
|
930
|
+
| **limit** | **Integer** | Maximum results (default 100) | [optional][default to 100] |
|
|
931
|
+
| **skip** | **Integer** | Offset for pagination | [optional][default to 0] |
|
|
932
|
+
|
|
933
|
+
### Return type
|
|
934
|
+
|
|
935
|
+
[**GetWhatsAppBroadcastRecipients200Response**](GetWhatsAppBroadcastRecipients200Response.md)
|
|
936
|
+
|
|
937
|
+
### Authorization
|
|
938
|
+
|
|
939
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
940
|
+
|
|
941
|
+
### HTTP request headers
|
|
942
|
+
|
|
943
|
+
- **Content-Type**: Not defined
|
|
944
|
+
- **Accept**: application/json
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
## get_whats_app_broadcasts
|
|
948
|
+
|
|
949
|
+
> <GetWhatsAppBroadcasts200Response> get_whats_app_broadcasts(account_id, opts)
|
|
950
|
+
|
|
951
|
+
List broadcasts
|
|
952
|
+
|
|
953
|
+
List all WhatsApp broadcasts for an account. Returns broadcasts sorted by creation date (newest first) without the full recipients list for performance.
|
|
954
|
+
|
|
955
|
+
### Examples
|
|
956
|
+
|
|
957
|
+
```ruby
|
|
958
|
+
require 'time'
|
|
959
|
+
require 'late-sdk'
|
|
960
|
+
# setup authorization
|
|
961
|
+
Late.configure do |config|
|
|
962
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
963
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
964
|
+
end
|
|
965
|
+
|
|
966
|
+
api_instance = Late::WhatsAppApi.new
|
|
967
|
+
account_id = 'account_id_example' # String | WhatsApp social account ID
|
|
968
|
+
opts = {
|
|
969
|
+
status: 'draft', # String | Filter by broadcast status
|
|
970
|
+
limit: 56, # Integer | Maximum results (default 50)
|
|
971
|
+
skip: 56 # Integer | Offset for pagination
|
|
972
|
+
}
|
|
973
|
+
|
|
974
|
+
begin
|
|
975
|
+
# List broadcasts
|
|
976
|
+
result = api_instance.get_whats_app_broadcasts(account_id, opts)
|
|
977
|
+
p result
|
|
978
|
+
rescue Late::ApiError => e
|
|
979
|
+
puts "Error when calling WhatsAppApi->get_whats_app_broadcasts: #{e}"
|
|
980
|
+
end
|
|
981
|
+
```
|
|
982
|
+
|
|
983
|
+
#### Using the get_whats_app_broadcasts_with_http_info variant
|
|
984
|
+
|
|
985
|
+
This returns an Array which contains the response data, status code and headers.
|
|
986
|
+
|
|
987
|
+
> <Array(<GetWhatsAppBroadcasts200Response>, Integer, Hash)> get_whats_app_broadcasts_with_http_info(account_id, opts)
|
|
988
|
+
|
|
989
|
+
```ruby
|
|
990
|
+
begin
|
|
991
|
+
# List broadcasts
|
|
992
|
+
data, status_code, headers = api_instance.get_whats_app_broadcasts_with_http_info(account_id, opts)
|
|
993
|
+
p status_code # => 2xx
|
|
994
|
+
p headers # => { ... }
|
|
995
|
+
p data # => <GetWhatsAppBroadcasts200Response>
|
|
996
|
+
rescue Late::ApiError => e
|
|
997
|
+
puts "Error when calling WhatsAppApi->get_whats_app_broadcasts_with_http_info: #{e}"
|
|
998
|
+
end
|
|
999
|
+
```
|
|
1000
|
+
|
|
1001
|
+
### Parameters
|
|
1002
|
+
|
|
1003
|
+
| Name | Type | Description | Notes |
|
|
1004
|
+
| ---- | ---- | ----------- | ----- |
|
|
1005
|
+
| **account_id** | **String** | WhatsApp social account ID | |
|
|
1006
|
+
| **status** | **String** | Filter by broadcast status | [optional] |
|
|
1007
|
+
| **limit** | **Integer** | Maximum results (default 50) | [optional][default to 50] |
|
|
1008
|
+
| **skip** | **Integer** | Offset for pagination | [optional][default to 0] |
|
|
1009
|
+
|
|
1010
|
+
### Return type
|
|
1011
|
+
|
|
1012
|
+
[**GetWhatsAppBroadcasts200Response**](GetWhatsAppBroadcasts200Response.md)
|
|
1013
|
+
|
|
1014
|
+
### Authorization
|
|
1015
|
+
|
|
1016
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1017
|
+
|
|
1018
|
+
### HTTP request headers
|
|
1019
|
+
|
|
1020
|
+
- **Content-Type**: Not defined
|
|
1021
|
+
- **Accept**: application/json
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
## get_whats_app_business_profile
|
|
1025
|
+
|
|
1026
|
+
> <GetWhatsAppBusinessProfile200Response> get_whats_app_business_profile(account_id)
|
|
1027
|
+
|
|
1028
|
+
Get business profile
|
|
1029
|
+
|
|
1030
|
+
Retrieve the WhatsApp Business profile for the account (about, address, description, email, websites, etc.).
|
|
1031
|
+
|
|
1032
|
+
### Examples
|
|
1033
|
+
|
|
1034
|
+
```ruby
|
|
1035
|
+
require 'time'
|
|
1036
|
+
require 'late-sdk'
|
|
1037
|
+
# setup authorization
|
|
1038
|
+
Late.configure do |config|
|
|
1039
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1040
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1041
|
+
end
|
|
1042
|
+
|
|
1043
|
+
api_instance = Late::WhatsAppApi.new
|
|
1044
|
+
account_id = 'account_id_example' # String | WhatsApp social account ID
|
|
1045
|
+
|
|
1046
|
+
begin
|
|
1047
|
+
# Get business profile
|
|
1048
|
+
result = api_instance.get_whats_app_business_profile(account_id)
|
|
1049
|
+
p result
|
|
1050
|
+
rescue Late::ApiError => e
|
|
1051
|
+
puts "Error when calling WhatsAppApi->get_whats_app_business_profile: #{e}"
|
|
1052
|
+
end
|
|
1053
|
+
```
|
|
1054
|
+
|
|
1055
|
+
#### Using the get_whats_app_business_profile_with_http_info variant
|
|
1056
|
+
|
|
1057
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1058
|
+
|
|
1059
|
+
> <Array(<GetWhatsAppBusinessProfile200Response>, Integer, Hash)> get_whats_app_business_profile_with_http_info(account_id)
|
|
1060
|
+
|
|
1061
|
+
```ruby
|
|
1062
|
+
begin
|
|
1063
|
+
# Get business profile
|
|
1064
|
+
data, status_code, headers = api_instance.get_whats_app_business_profile_with_http_info(account_id)
|
|
1065
|
+
p status_code # => 2xx
|
|
1066
|
+
p headers # => { ... }
|
|
1067
|
+
p data # => <GetWhatsAppBusinessProfile200Response>
|
|
1068
|
+
rescue Late::ApiError => e
|
|
1069
|
+
puts "Error when calling WhatsAppApi->get_whats_app_business_profile_with_http_info: #{e}"
|
|
1070
|
+
end
|
|
1071
|
+
```
|
|
1072
|
+
|
|
1073
|
+
### Parameters
|
|
1074
|
+
|
|
1075
|
+
| Name | Type | Description | Notes |
|
|
1076
|
+
| ---- | ---- | ----------- | ----- |
|
|
1077
|
+
| **account_id** | **String** | WhatsApp social account ID | |
|
|
1078
|
+
|
|
1079
|
+
### Return type
|
|
1080
|
+
|
|
1081
|
+
[**GetWhatsAppBusinessProfile200Response**](GetWhatsAppBusinessProfile200Response.md)
|
|
1082
|
+
|
|
1083
|
+
### Authorization
|
|
1084
|
+
|
|
1085
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1086
|
+
|
|
1087
|
+
### HTTP request headers
|
|
1088
|
+
|
|
1089
|
+
- **Content-Type**: Not defined
|
|
1090
|
+
- **Accept**: application/json
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
## get_whats_app_contact
|
|
1094
|
+
|
|
1095
|
+
> <GetWhatsAppContact200Response> get_whats_app_contact(contact_id)
|
|
1096
|
+
|
|
1097
|
+
Get contact
|
|
1098
|
+
|
|
1099
|
+
Retrieve a single WhatsApp contact by ID with full details.
|
|
1100
|
+
|
|
1101
|
+
### Examples
|
|
1102
|
+
|
|
1103
|
+
```ruby
|
|
1104
|
+
require 'time'
|
|
1105
|
+
require 'late-sdk'
|
|
1106
|
+
# setup authorization
|
|
1107
|
+
Late.configure do |config|
|
|
1108
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1109
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1110
|
+
end
|
|
1111
|
+
|
|
1112
|
+
api_instance = Late::WhatsAppApi.new
|
|
1113
|
+
contact_id = 'contact_id_example' # String | Contact ID
|
|
1114
|
+
|
|
1115
|
+
begin
|
|
1116
|
+
# Get contact
|
|
1117
|
+
result = api_instance.get_whats_app_contact(contact_id)
|
|
1118
|
+
p result
|
|
1119
|
+
rescue Late::ApiError => e
|
|
1120
|
+
puts "Error when calling WhatsAppApi->get_whats_app_contact: #{e}"
|
|
1121
|
+
end
|
|
1122
|
+
```
|
|
1123
|
+
|
|
1124
|
+
#### Using the get_whats_app_contact_with_http_info variant
|
|
1125
|
+
|
|
1126
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1127
|
+
|
|
1128
|
+
> <Array(<GetWhatsAppContact200Response>, Integer, Hash)> get_whats_app_contact_with_http_info(contact_id)
|
|
1129
|
+
|
|
1130
|
+
```ruby
|
|
1131
|
+
begin
|
|
1132
|
+
# Get contact
|
|
1133
|
+
data, status_code, headers = api_instance.get_whats_app_contact_with_http_info(contact_id)
|
|
1134
|
+
p status_code # => 2xx
|
|
1135
|
+
p headers # => { ... }
|
|
1136
|
+
p data # => <GetWhatsAppContact200Response>
|
|
1137
|
+
rescue Late::ApiError => e
|
|
1138
|
+
puts "Error when calling WhatsAppApi->get_whats_app_contact_with_http_info: #{e}"
|
|
1139
|
+
end
|
|
1140
|
+
```
|
|
1141
|
+
|
|
1142
|
+
### Parameters
|
|
1143
|
+
|
|
1144
|
+
| Name | Type | Description | Notes |
|
|
1145
|
+
| ---- | ---- | ----------- | ----- |
|
|
1146
|
+
| **contact_id** | **String** | Contact ID | |
|
|
1147
|
+
|
|
1148
|
+
### Return type
|
|
1149
|
+
|
|
1150
|
+
[**GetWhatsAppContact200Response**](GetWhatsAppContact200Response.md)
|
|
1151
|
+
|
|
1152
|
+
### Authorization
|
|
1153
|
+
|
|
1154
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1155
|
+
|
|
1156
|
+
### HTTP request headers
|
|
1157
|
+
|
|
1158
|
+
- **Content-Type**: Not defined
|
|
1159
|
+
- **Accept**: application/json
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
## get_whats_app_contacts
|
|
1163
|
+
|
|
1164
|
+
> <GetWhatsAppContacts200Response> get_whats_app_contacts(account_id, opts)
|
|
1165
|
+
|
|
1166
|
+
List contacts
|
|
1167
|
+
|
|
1168
|
+
List WhatsApp contacts for an account. Supports filtering by tags, groups, opt-in status, and text search. Returns contacts sorted by name with available filter options.
|
|
1169
|
+
|
|
1170
|
+
### Examples
|
|
1171
|
+
|
|
1172
|
+
```ruby
|
|
1173
|
+
require 'time'
|
|
1174
|
+
require 'late-sdk'
|
|
1175
|
+
# setup authorization
|
|
1176
|
+
Late.configure do |config|
|
|
1177
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1178
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1179
|
+
end
|
|
1180
|
+
|
|
1181
|
+
api_instance = Late::WhatsAppApi.new
|
|
1182
|
+
account_id = 'account_id_example' # String | WhatsApp social account ID
|
|
1183
|
+
opts = {
|
|
1184
|
+
search: 'search_example', # String | Search contacts by name, phone, email, or company
|
|
1185
|
+
tag: 'tag_example', # String | Filter by tag
|
|
1186
|
+
group: 'group_example', # String | Filter by group
|
|
1187
|
+
opted_in: 'true', # String | Filter by opt-in status
|
|
1188
|
+
limit: 56, # Integer | Maximum results (default 50)
|
|
1189
|
+
skip: 56 # Integer | Offset for pagination
|
|
1190
|
+
}
|
|
1191
|
+
|
|
1192
|
+
begin
|
|
1193
|
+
# List contacts
|
|
1194
|
+
result = api_instance.get_whats_app_contacts(account_id, opts)
|
|
1195
|
+
p result
|
|
1196
|
+
rescue Late::ApiError => e
|
|
1197
|
+
puts "Error when calling WhatsAppApi->get_whats_app_contacts: #{e}"
|
|
1198
|
+
end
|
|
1199
|
+
```
|
|
1200
|
+
|
|
1201
|
+
#### Using the get_whats_app_contacts_with_http_info variant
|
|
1202
|
+
|
|
1203
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1204
|
+
|
|
1205
|
+
> <Array(<GetWhatsAppContacts200Response>, Integer, Hash)> get_whats_app_contacts_with_http_info(account_id, opts)
|
|
1206
|
+
|
|
1207
|
+
```ruby
|
|
1208
|
+
begin
|
|
1209
|
+
# List contacts
|
|
1210
|
+
data, status_code, headers = api_instance.get_whats_app_contacts_with_http_info(account_id, opts)
|
|
1211
|
+
p status_code # => 2xx
|
|
1212
|
+
p headers # => { ... }
|
|
1213
|
+
p data # => <GetWhatsAppContacts200Response>
|
|
1214
|
+
rescue Late::ApiError => e
|
|
1215
|
+
puts "Error when calling WhatsAppApi->get_whats_app_contacts_with_http_info: #{e}"
|
|
1216
|
+
end
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
### Parameters
|
|
1220
|
+
|
|
1221
|
+
| Name | Type | Description | Notes |
|
|
1222
|
+
| ---- | ---- | ----------- | ----- |
|
|
1223
|
+
| **account_id** | **String** | WhatsApp social account ID | |
|
|
1224
|
+
| **search** | **String** | Search contacts by name, phone, email, or company | [optional] |
|
|
1225
|
+
| **tag** | **String** | Filter by tag | [optional] |
|
|
1226
|
+
| **group** | **String** | Filter by group | [optional] |
|
|
1227
|
+
| **opted_in** | **String** | Filter by opt-in status | [optional] |
|
|
1228
|
+
| **limit** | **Integer** | Maximum results (default 50) | [optional][default to 50] |
|
|
1229
|
+
| **skip** | **Integer** | Offset for pagination | [optional][default to 0] |
|
|
1230
|
+
|
|
1231
|
+
### Return type
|
|
1232
|
+
|
|
1233
|
+
[**GetWhatsAppContacts200Response**](GetWhatsAppContacts200Response.md)
|
|
1234
|
+
|
|
1235
|
+
### Authorization
|
|
1236
|
+
|
|
1237
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1238
|
+
|
|
1239
|
+
### HTTP request headers
|
|
1240
|
+
|
|
1241
|
+
- **Content-Type**: Not defined
|
|
1242
|
+
- **Accept**: application/json
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
## get_whats_app_groups
|
|
1246
|
+
|
|
1247
|
+
> <GetWhatsAppGroups200Response> get_whats_app_groups(account_id)
|
|
1248
|
+
|
|
1249
|
+
List contact groups
|
|
1250
|
+
|
|
1251
|
+
List all contact groups for a WhatsApp account with contact counts. Groups are derived from the groups field on contacts, not stored as separate documents.
|
|
1252
|
+
|
|
1253
|
+
### Examples
|
|
1254
|
+
|
|
1255
|
+
```ruby
|
|
1256
|
+
require 'time'
|
|
1257
|
+
require 'late-sdk'
|
|
1258
|
+
# setup authorization
|
|
1259
|
+
Late.configure do |config|
|
|
1260
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1261
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1262
|
+
end
|
|
1263
|
+
|
|
1264
|
+
api_instance = Late::WhatsAppApi.new
|
|
1265
|
+
account_id = 'account_id_example' # String | WhatsApp social account ID
|
|
1266
|
+
|
|
1267
|
+
begin
|
|
1268
|
+
# List contact groups
|
|
1269
|
+
result = api_instance.get_whats_app_groups(account_id)
|
|
1270
|
+
p result
|
|
1271
|
+
rescue Late::ApiError => e
|
|
1272
|
+
puts "Error when calling WhatsAppApi->get_whats_app_groups: #{e}"
|
|
1273
|
+
end
|
|
1274
|
+
```
|
|
1275
|
+
|
|
1276
|
+
#### Using the get_whats_app_groups_with_http_info variant
|
|
1277
|
+
|
|
1278
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1279
|
+
|
|
1280
|
+
> <Array(<GetWhatsAppGroups200Response>, Integer, Hash)> get_whats_app_groups_with_http_info(account_id)
|
|
1281
|
+
|
|
1282
|
+
```ruby
|
|
1283
|
+
begin
|
|
1284
|
+
# List contact groups
|
|
1285
|
+
data, status_code, headers = api_instance.get_whats_app_groups_with_http_info(account_id)
|
|
1286
|
+
p status_code # => 2xx
|
|
1287
|
+
p headers # => { ... }
|
|
1288
|
+
p data # => <GetWhatsAppGroups200Response>
|
|
1289
|
+
rescue Late::ApiError => e
|
|
1290
|
+
puts "Error when calling WhatsAppApi->get_whats_app_groups_with_http_info: #{e}"
|
|
1291
|
+
end
|
|
1292
|
+
```
|
|
1293
|
+
|
|
1294
|
+
### Parameters
|
|
1295
|
+
|
|
1296
|
+
| Name | Type | Description | Notes |
|
|
1297
|
+
| ---- | ---- | ----------- | ----- |
|
|
1298
|
+
| **account_id** | **String** | WhatsApp social account ID | |
|
|
1299
|
+
|
|
1300
|
+
### Return type
|
|
1301
|
+
|
|
1302
|
+
[**GetWhatsAppGroups200Response**](GetWhatsAppGroups200Response.md)
|
|
1303
|
+
|
|
1304
|
+
### Authorization
|
|
1305
|
+
|
|
1306
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1307
|
+
|
|
1308
|
+
### HTTP request headers
|
|
1309
|
+
|
|
1310
|
+
- **Content-Type**: Not defined
|
|
1311
|
+
- **Accept**: application/json
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
## get_whats_app_template
|
|
1315
|
+
|
|
1316
|
+
> <GetWhatsAppTemplate200Response> get_whats_app_template(template_name, account_id)
|
|
1317
|
+
|
|
1318
|
+
Get template
|
|
1319
|
+
|
|
1320
|
+
Retrieve a single message template by name.
|
|
1321
|
+
|
|
1322
|
+
### Examples
|
|
1323
|
+
|
|
1324
|
+
```ruby
|
|
1325
|
+
require 'time'
|
|
1326
|
+
require 'late-sdk'
|
|
1327
|
+
# setup authorization
|
|
1328
|
+
Late.configure do |config|
|
|
1329
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1330
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1331
|
+
end
|
|
1332
|
+
|
|
1333
|
+
api_instance = Late::WhatsAppApi.new
|
|
1334
|
+
template_name = 'template_name_example' # String | Template name
|
|
1335
|
+
account_id = 'account_id_example' # String | WhatsApp social account ID
|
|
1336
|
+
|
|
1337
|
+
begin
|
|
1338
|
+
# Get template
|
|
1339
|
+
result = api_instance.get_whats_app_template(template_name, account_id)
|
|
1340
|
+
p result
|
|
1341
|
+
rescue Late::ApiError => e
|
|
1342
|
+
puts "Error when calling WhatsAppApi->get_whats_app_template: #{e}"
|
|
1343
|
+
end
|
|
1344
|
+
```
|
|
1345
|
+
|
|
1346
|
+
#### Using the get_whats_app_template_with_http_info variant
|
|
1347
|
+
|
|
1348
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1349
|
+
|
|
1350
|
+
> <Array(<GetWhatsAppTemplate200Response>, Integer, Hash)> get_whats_app_template_with_http_info(template_name, account_id)
|
|
1351
|
+
|
|
1352
|
+
```ruby
|
|
1353
|
+
begin
|
|
1354
|
+
# Get template
|
|
1355
|
+
data, status_code, headers = api_instance.get_whats_app_template_with_http_info(template_name, account_id)
|
|
1356
|
+
p status_code # => 2xx
|
|
1357
|
+
p headers # => { ... }
|
|
1358
|
+
p data # => <GetWhatsAppTemplate200Response>
|
|
1359
|
+
rescue Late::ApiError => e
|
|
1360
|
+
puts "Error when calling WhatsAppApi->get_whats_app_template_with_http_info: #{e}"
|
|
1361
|
+
end
|
|
1362
|
+
```
|
|
1363
|
+
|
|
1364
|
+
### Parameters
|
|
1365
|
+
|
|
1366
|
+
| Name | Type | Description | Notes |
|
|
1367
|
+
| ---- | ---- | ----------- | ----- |
|
|
1368
|
+
| **template_name** | **String** | Template name | |
|
|
1369
|
+
| **account_id** | **String** | WhatsApp social account ID | |
|
|
1370
|
+
|
|
1371
|
+
### Return type
|
|
1372
|
+
|
|
1373
|
+
[**GetWhatsAppTemplate200Response**](GetWhatsAppTemplate200Response.md)
|
|
1374
|
+
|
|
1375
|
+
### Authorization
|
|
1376
|
+
|
|
1377
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1378
|
+
|
|
1379
|
+
### HTTP request headers
|
|
1380
|
+
|
|
1381
|
+
- **Content-Type**: Not defined
|
|
1382
|
+
- **Accept**: application/json
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
## get_whats_app_templates
|
|
1386
|
+
|
|
1387
|
+
> <GetWhatsAppTemplates200Response> get_whats_app_templates(account_id)
|
|
1388
|
+
|
|
1389
|
+
List templates
|
|
1390
|
+
|
|
1391
|
+
List all message templates for the WhatsApp Business Account (WABA) associated with the given account. Templates are fetched directly from the WhatsApp Cloud API.
|
|
1392
|
+
|
|
1393
|
+
### Examples
|
|
1394
|
+
|
|
1395
|
+
```ruby
|
|
1396
|
+
require 'time'
|
|
1397
|
+
require 'late-sdk'
|
|
1398
|
+
# setup authorization
|
|
1399
|
+
Late.configure do |config|
|
|
1400
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1401
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1402
|
+
end
|
|
1403
|
+
|
|
1404
|
+
api_instance = Late::WhatsAppApi.new
|
|
1405
|
+
account_id = 'account_id_example' # String | WhatsApp social account ID
|
|
1406
|
+
|
|
1407
|
+
begin
|
|
1408
|
+
# List templates
|
|
1409
|
+
result = api_instance.get_whats_app_templates(account_id)
|
|
1410
|
+
p result
|
|
1411
|
+
rescue Late::ApiError => e
|
|
1412
|
+
puts "Error when calling WhatsAppApi->get_whats_app_templates: #{e}"
|
|
1413
|
+
end
|
|
1414
|
+
```
|
|
1415
|
+
|
|
1416
|
+
#### Using the get_whats_app_templates_with_http_info variant
|
|
1417
|
+
|
|
1418
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1419
|
+
|
|
1420
|
+
> <Array(<GetWhatsAppTemplates200Response>, Integer, Hash)> get_whats_app_templates_with_http_info(account_id)
|
|
1421
|
+
|
|
1422
|
+
```ruby
|
|
1423
|
+
begin
|
|
1424
|
+
# List templates
|
|
1425
|
+
data, status_code, headers = api_instance.get_whats_app_templates_with_http_info(account_id)
|
|
1426
|
+
p status_code # => 2xx
|
|
1427
|
+
p headers # => { ... }
|
|
1428
|
+
p data # => <GetWhatsAppTemplates200Response>
|
|
1429
|
+
rescue Late::ApiError => e
|
|
1430
|
+
puts "Error when calling WhatsAppApi->get_whats_app_templates_with_http_info: #{e}"
|
|
1431
|
+
end
|
|
1432
|
+
```
|
|
1433
|
+
|
|
1434
|
+
### Parameters
|
|
1435
|
+
|
|
1436
|
+
| Name | Type | Description | Notes |
|
|
1437
|
+
| ---- | ---- | ----------- | ----- |
|
|
1438
|
+
| **account_id** | **String** | WhatsApp social account ID | |
|
|
1439
|
+
|
|
1440
|
+
### Return type
|
|
1441
|
+
|
|
1442
|
+
[**GetWhatsAppTemplates200Response**](GetWhatsAppTemplates200Response.md)
|
|
1443
|
+
|
|
1444
|
+
### Authorization
|
|
1445
|
+
|
|
1446
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1447
|
+
|
|
1448
|
+
### HTTP request headers
|
|
1449
|
+
|
|
1450
|
+
- **Content-Type**: Not defined
|
|
1451
|
+
- **Accept**: application/json
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
## import_whats_app_contacts
|
|
1455
|
+
|
|
1456
|
+
> <ImportWhatsAppContacts200Response> import_whats_app_contacts(import_whats_app_contacts_request)
|
|
1457
|
+
|
|
1458
|
+
Bulk import contacts
|
|
1459
|
+
|
|
1460
|
+
Import up to 1000 contacts at once. Each contact requires a phone number and name. Duplicates are skipped by default. Supports default tags and groups applied to all imported contacts.
|
|
1461
|
+
|
|
1462
|
+
### Examples
|
|
1463
|
+
|
|
1464
|
+
```ruby
|
|
1465
|
+
require 'time'
|
|
1466
|
+
require 'late-sdk'
|
|
1467
|
+
# setup authorization
|
|
1468
|
+
Late.configure do |config|
|
|
1469
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1470
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1471
|
+
end
|
|
1472
|
+
|
|
1473
|
+
api_instance = Late::WhatsAppApi.new
|
|
1474
|
+
import_whats_app_contacts_request = Late::ImportWhatsAppContactsRequest.new({account_id: 'account_id_example', contacts: [Late::ImportWhatsAppContactsRequestContactsInner.new({phone: 'phone_example', name: 'name_example'})]}) # ImportWhatsAppContactsRequest |
|
|
1475
|
+
|
|
1476
|
+
begin
|
|
1477
|
+
# Bulk import contacts
|
|
1478
|
+
result = api_instance.import_whats_app_contacts(import_whats_app_contacts_request)
|
|
1479
|
+
p result
|
|
1480
|
+
rescue Late::ApiError => e
|
|
1481
|
+
puts "Error when calling WhatsAppApi->import_whats_app_contacts: #{e}"
|
|
1482
|
+
end
|
|
1483
|
+
```
|
|
1484
|
+
|
|
1485
|
+
#### Using the import_whats_app_contacts_with_http_info variant
|
|
1486
|
+
|
|
1487
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1488
|
+
|
|
1489
|
+
> <Array(<ImportWhatsAppContacts200Response>, Integer, Hash)> import_whats_app_contacts_with_http_info(import_whats_app_contacts_request)
|
|
1490
|
+
|
|
1491
|
+
```ruby
|
|
1492
|
+
begin
|
|
1493
|
+
# Bulk import contacts
|
|
1494
|
+
data, status_code, headers = api_instance.import_whats_app_contacts_with_http_info(import_whats_app_contacts_request)
|
|
1495
|
+
p status_code # => 2xx
|
|
1496
|
+
p headers # => { ... }
|
|
1497
|
+
p data # => <ImportWhatsAppContacts200Response>
|
|
1498
|
+
rescue Late::ApiError => e
|
|
1499
|
+
puts "Error when calling WhatsAppApi->import_whats_app_contacts_with_http_info: #{e}"
|
|
1500
|
+
end
|
|
1501
|
+
```
|
|
1502
|
+
|
|
1503
|
+
### Parameters
|
|
1504
|
+
|
|
1505
|
+
| Name | Type | Description | Notes |
|
|
1506
|
+
| ---- | ---- | ----------- | ----- |
|
|
1507
|
+
| **import_whats_app_contacts_request** | [**ImportWhatsAppContactsRequest**](ImportWhatsAppContactsRequest.md) | | |
|
|
1508
|
+
|
|
1509
|
+
### Return type
|
|
1510
|
+
|
|
1511
|
+
[**ImportWhatsAppContacts200Response**](ImportWhatsAppContacts200Response.md)
|
|
1512
|
+
|
|
1513
|
+
### Authorization
|
|
1514
|
+
|
|
1515
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1516
|
+
|
|
1517
|
+
### HTTP request headers
|
|
1518
|
+
|
|
1519
|
+
- **Content-Type**: application/json
|
|
1520
|
+
- **Accept**: application/json
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
## remove_whats_app_broadcast_recipients
|
|
1524
|
+
|
|
1525
|
+
> <RemoveWhatsAppBroadcastRecipients200Response> remove_whats_app_broadcast_recipients(broadcast_id, remove_whats_app_broadcast_recipients_request)
|
|
1526
|
+
|
|
1527
|
+
Remove recipients
|
|
1528
|
+
|
|
1529
|
+
Remove recipients from a draft broadcast by phone number.
|
|
1530
|
+
|
|
1531
|
+
### Examples
|
|
1532
|
+
|
|
1533
|
+
```ruby
|
|
1534
|
+
require 'time'
|
|
1535
|
+
require 'late-sdk'
|
|
1536
|
+
# setup authorization
|
|
1537
|
+
Late.configure do |config|
|
|
1538
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1539
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1540
|
+
end
|
|
1541
|
+
|
|
1542
|
+
api_instance = Late::WhatsAppApi.new
|
|
1543
|
+
broadcast_id = 'broadcast_id_example' # String | Broadcast ID
|
|
1544
|
+
remove_whats_app_broadcast_recipients_request = Late::RemoveWhatsAppBroadcastRecipientsRequest.new({phones: ['phones_example']}) # RemoveWhatsAppBroadcastRecipientsRequest |
|
|
1545
|
+
|
|
1546
|
+
begin
|
|
1547
|
+
# Remove recipients
|
|
1548
|
+
result = api_instance.remove_whats_app_broadcast_recipients(broadcast_id, remove_whats_app_broadcast_recipients_request)
|
|
1549
|
+
p result
|
|
1550
|
+
rescue Late::ApiError => e
|
|
1551
|
+
puts "Error when calling WhatsAppApi->remove_whats_app_broadcast_recipients: #{e}"
|
|
1552
|
+
end
|
|
1553
|
+
```
|
|
1554
|
+
|
|
1555
|
+
#### Using the remove_whats_app_broadcast_recipients_with_http_info variant
|
|
1556
|
+
|
|
1557
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1558
|
+
|
|
1559
|
+
> <Array(<RemoveWhatsAppBroadcastRecipients200Response>, Integer, Hash)> remove_whats_app_broadcast_recipients_with_http_info(broadcast_id, remove_whats_app_broadcast_recipients_request)
|
|
1560
|
+
|
|
1561
|
+
```ruby
|
|
1562
|
+
begin
|
|
1563
|
+
# Remove recipients
|
|
1564
|
+
data, status_code, headers = api_instance.remove_whats_app_broadcast_recipients_with_http_info(broadcast_id, remove_whats_app_broadcast_recipients_request)
|
|
1565
|
+
p status_code # => 2xx
|
|
1566
|
+
p headers # => { ... }
|
|
1567
|
+
p data # => <RemoveWhatsAppBroadcastRecipients200Response>
|
|
1568
|
+
rescue Late::ApiError => e
|
|
1569
|
+
puts "Error when calling WhatsAppApi->remove_whats_app_broadcast_recipients_with_http_info: #{e}"
|
|
1570
|
+
end
|
|
1571
|
+
```
|
|
1572
|
+
|
|
1573
|
+
### Parameters
|
|
1574
|
+
|
|
1575
|
+
| Name | Type | Description | Notes |
|
|
1576
|
+
| ---- | ---- | ----------- | ----- |
|
|
1577
|
+
| **broadcast_id** | **String** | Broadcast ID | |
|
|
1578
|
+
| **remove_whats_app_broadcast_recipients_request** | [**RemoveWhatsAppBroadcastRecipientsRequest**](RemoveWhatsAppBroadcastRecipientsRequest.md) | | |
|
|
1579
|
+
|
|
1580
|
+
### Return type
|
|
1581
|
+
|
|
1582
|
+
[**RemoveWhatsAppBroadcastRecipients200Response**](RemoveWhatsAppBroadcastRecipients200Response.md)
|
|
1583
|
+
|
|
1584
|
+
### Authorization
|
|
1585
|
+
|
|
1586
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1587
|
+
|
|
1588
|
+
### HTTP request headers
|
|
1589
|
+
|
|
1590
|
+
- **Content-Type**: application/json
|
|
1591
|
+
- **Accept**: application/json
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
## rename_whats_app_group
|
|
1595
|
+
|
|
1596
|
+
> <RenameWhatsAppGroup200Response> rename_whats_app_group(rename_whats_app_group_request)
|
|
1597
|
+
|
|
1598
|
+
Rename group
|
|
1599
|
+
|
|
1600
|
+
Rename a contact group. This updates the group name on all contacts that belong to the group.
|
|
1601
|
+
|
|
1602
|
+
### Examples
|
|
1603
|
+
|
|
1604
|
+
```ruby
|
|
1605
|
+
require 'time'
|
|
1606
|
+
require 'late-sdk'
|
|
1607
|
+
# setup authorization
|
|
1608
|
+
Late.configure do |config|
|
|
1609
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1610
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1611
|
+
end
|
|
1612
|
+
|
|
1613
|
+
api_instance = Late::WhatsAppApi.new
|
|
1614
|
+
rename_whats_app_group_request = Late::RenameWhatsAppGroupRequest.new({account_id: 'account_id_example', old_name: 'old_name_example', new_name: 'new_name_example'}) # RenameWhatsAppGroupRequest |
|
|
1615
|
+
|
|
1616
|
+
begin
|
|
1617
|
+
# Rename group
|
|
1618
|
+
result = api_instance.rename_whats_app_group(rename_whats_app_group_request)
|
|
1619
|
+
p result
|
|
1620
|
+
rescue Late::ApiError => e
|
|
1621
|
+
puts "Error when calling WhatsAppApi->rename_whats_app_group: #{e}"
|
|
1622
|
+
end
|
|
1623
|
+
```
|
|
1624
|
+
|
|
1625
|
+
#### Using the rename_whats_app_group_with_http_info variant
|
|
1626
|
+
|
|
1627
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1628
|
+
|
|
1629
|
+
> <Array(<RenameWhatsAppGroup200Response>, Integer, Hash)> rename_whats_app_group_with_http_info(rename_whats_app_group_request)
|
|
1630
|
+
|
|
1631
|
+
```ruby
|
|
1632
|
+
begin
|
|
1633
|
+
# Rename group
|
|
1634
|
+
data, status_code, headers = api_instance.rename_whats_app_group_with_http_info(rename_whats_app_group_request)
|
|
1635
|
+
p status_code # => 2xx
|
|
1636
|
+
p headers # => { ... }
|
|
1637
|
+
p data # => <RenameWhatsAppGroup200Response>
|
|
1638
|
+
rescue Late::ApiError => e
|
|
1639
|
+
puts "Error when calling WhatsAppApi->rename_whats_app_group_with_http_info: #{e}"
|
|
1640
|
+
end
|
|
1641
|
+
```
|
|
1642
|
+
|
|
1643
|
+
### Parameters
|
|
1644
|
+
|
|
1645
|
+
| Name | Type | Description | Notes |
|
|
1646
|
+
| ---- | ---- | ----------- | ----- |
|
|
1647
|
+
| **rename_whats_app_group_request** | [**RenameWhatsAppGroupRequest**](RenameWhatsAppGroupRequest.md) | | |
|
|
1648
|
+
|
|
1649
|
+
### Return type
|
|
1650
|
+
|
|
1651
|
+
[**RenameWhatsAppGroup200Response**](RenameWhatsAppGroup200Response.md)
|
|
1652
|
+
|
|
1653
|
+
### Authorization
|
|
1654
|
+
|
|
1655
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1656
|
+
|
|
1657
|
+
### HTTP request headers
|
|
1658
|
+
|
|
1659
|
+
- **Content-Type**: application/json
|
|
1660
|
+
- **Accept**: application/json
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
## schedule_whats_app_broadcast
|
|
1664
|
+
|
|
1665
|
+
> <ScheduleWhatsAppBroadcast200Response> schedule_whats_app_broadcast(broadcast_id, schedule_whats_app_broadcast_request)
|
|
1666
|
+
|
|
1667
|
+
Schedule broadcast
|
|
1668
|
+
|
|
1669
|
+
Schedule a draft broadcast for future sending. The scheduled time must be in the future and no more than 30 days in advance. The broadcast must be in draft status and have recipients.
|
|
1670
|
+
|
|
1671
|
+
### Examples
|
|
1672
|
+
|
|
1673
|
+
```ruby
|
|
1674
|
+
require 'time'
|
|
1675
|
+
require 'late-sdk'
|
|
1676
|
+
# setup authorization
|
|
1677
|
+
Late.configure do |config|
|
|
1678
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1679
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1680
|
+
end
|
|
1681
|
+
|
|
1682
|
+
api_instance = Late::WhatsAppApi.new
|
|
1683
|
+
broadcast_id = 'broadcast_id_example' # String | Broadcast ID
|
|
1684
|
+
schedule_whats_app_broadcast_request = Late::ScheduleWhatsAppBroadcastRequest.new({scheduled_at: Time.now}) # ScheduleWhatsAppBroadcastRequest |
|
|
1685
|
+
|
|
1686
|
+
begin
|
|
1687
|
+
# Schedule broadcast
|
|
1688
|
+
result = api_instance.schedule_whats_app_broadcast(broadcast_id, schedule_whats_app_broadcast_request)
|
|
1689
|
+
p result
|
|
1690
|
+
rescue Late::ApiError => e
|
|
1691
|
+
puts "Error when calling WhatsAppApi->schedule_whats_app_broadcast: #{e}"
|
|
1692
|
+
end
|
|
1693
|
+
```
|
|
1694
|
+
|
|
1695
|
+
#### Using the schedule_whats_app_broadcast_with_http_info variant
|
|
1696
|
+
|
|
1697
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1698
|
+
|
|
1699
|
+
> <Array(<ScheduleWhatsAppBroadcast200Response>, Integer, Hash)> schedule_whats_app_broadcast_with_http_info(broadcast_id, schedule_whats_app_broadcast_request)
|
|
1700
|
+
|
|
1701
|
+
```ruby
|
|
1702
|
+
begin
|
|
1703
|
+
# Schedule broadcast
|
|
1704
|
+
data, status_code, headers = api_instance.schedule_whats_app_broadcast_with_http_info(broadcast_id, schedule_whats_app_broadcast_request)
|
|
1705
|
+
p status_code # => 2xx
|
|
1706
|
+
p headers # => { ... }
|
|
1707
|
+
p data # => <ScheduleWhatsAppBroadcast200Response>
|
|
1708
|
+
rescue Late::ApiError => e
|
|
1709
|
+
puts "Error when calling WhatsAppApi->schedule_whats_app_broadcast_with_http_info: #{e}"
|
|
1710
|
+
end
|
|
1711
|
+
```
|
|
1712
|
+
|
|
1713
|
+
### Parameters
|
|
1714
|
+
|
|
1715
|
+
| Name | Type | Description | Notes |
|
|
1716
|
+
| ---- | ---- | ----------- | ----- |
|
|
1717
|
+
| **broadcast_id** | **String** | Broadcast ID | |
|
|
1718
|
+
| **schedule_whats_app_broadcast_request** | [**ScheduleWhatsAppBroadcastRequest**](ScheduleWhatsAppBroadcastRequest.md) | | |
|
|
1719
|
+
|
|
1720
|
+
### Return type
|
|
1721
|
+
|
|
1722
|
+
[**ScheduleWhatsAppBroadcast200Response**](ScheduleWhatsAppBroadcast200Response.md)
|
|
1723
|
+
|
|
1724
|
+
### Authorization
|
|
1725
|
+
|
|
1726
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1727
|
+
|
|
1728
|
+
### HTTP request headers
|
|
1729
|
+
|
|
1730
|
+
- **Content-Type**: application/json
|
|
1731
|
+
- **Accept**: application/json
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
## send_whats_app_broadcast
|
|
1735
|
+
|
|
1736
|
+
> <SendWhatsAppBroadcast200Response> send_whats_app_broadcast(broadcast_id)
|
|
1737
|
+
|
|
1738
|
+
Send broadcast
|
|
1739
|
+
|
|
1740
|
+
Start sending a broadcast immediately. The broadcast must be in draft or scheduled status and have at least one recipient. Messages are sent sequentially with rate limiting.
|
|
1741
|
+
|
|
1742
|
+
### Examples
|
|
1743
|
+
|
|
1744
|
+
```ruby
|
|
1745
|
+
require 'time'
|
|
1746
|
+
require 'late-sdk'
|
|
1747
|
+
# setup authorization
|
|
1748
|
+
Late.configure do |config|
|
|
1749
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1750
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1751
|
+
end
|
|
1752
|
+
|
|
1753
|
+
api_instance = Late::WhatsAppApi.new
|
|
1754
|
+
broadcast_id = 'broadcast_id_example' # String | Broadcast ID
|
|
1755
|
+
|
|
1756
|
+
begin
|
|
1757
|
+
# Send broadcast
|
|
1758
|
+
result = api_instance.send_whats_app_broadcast(broadcast_id)
|
|
1759
|
+
p result
|
|
1760
|
+
rescue Late::ApiError => e
|
|
1761
|
+
puts "Error when calling WhatsAppApi->send_whats_app_broadcast: #{e}"
|
|
1762
|
+
end
|
|
1763
|
+
```
|
|
1764
|
+
|
|
1765
|
+
#### Using the send_whats_app_broadcast_with_http_info variant
|
|
1766
|
+
|
|
1767
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1768
|
+
|
|
1769
|
+
> <Array(<SendWhatsAppBroadcast200Response>, Integer, Hash)> send_whats_app_broadcast_with_http_info(broadcast_id)
|
|
1770
|
+
|
|
1771
|
+
```ruby
|
|
1772
|
+
begin
|
|
1773
|
+
# Send broadcast
|
|
1774
|
+
data, status_code, headers = api_instance.send_whats_app_broadcast_with_http_info(broadcast_id)
|
|
1775
|
+
p status_code # => 2xx
|
|
1776
|
+
p headers # => { ... }
|
|
1777
|
+
p data # => <SendWhatsAppBroadcast200Response>
|
|
1778
|
+
rescue Late::ApiError => e
|
|
1779
|
+
puts "Error when calling WhatsAppApi->send_whats_app_broadcast_with_http_info: #{e}"
|
|
1780
|
+
end
|
|
1781
|
+
```
|
|
1782
|
+
|
|
1783
|
+
### Parameters
|
|
1784
|
+
|
|
1785
|
+
| Name | Type | Description | Notes |
|
|
1786
|
+
| ---- | ---- | ----------- | ----- |
|
|
1787
|
+
| **broadcast_id** | **String** | Broadcast ID | |
|
|
1788
|
+
|
|
1789
|
+
### Return type
|
|
1790
|
+
|
|
1791
|
+
[**SendWhatsAppBroadcast200Response**](SendWhatsAppBroadcast200Response.md)
|
|
1792
|
+
|
|
1793
|
+
### Authorization
|
|
1794
|
+
|
|
1795
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1796
|
+
|
|
1797
|
+
### HTTP request headers
|
|
1798
|
+
|
|
1799
|
+
- **Content-Type**: Not defined
|
|
1800
|
+
- **Accept**: application/json
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
## send_whats_app_bulk
|
|
1804
|
+
|
|
1805
|
+
> <SendWhatsAppBulk200Response> send_whats_app_bulk(send_whats_app_bulk_request)
|
|
1806
|
+
|
|
1807
|
+
Bulk send template messages
|
|
1808
|
+
|
|
1809
|
+
Send a template message to multiple recipients in a single request. Maximum 100 recipients per request. Only template messages are supported for bulk sending (not free-form text). Each recipient can have optional per-recipient template variables for personalization. Returns detailed results for each recipient.
|
|
1810
|
+
|
|
1811
|
+
### Examples
|
|
1812
|
+
|
|
1813
|
+
```ruby
|
|
1814
|
+
require 'time'
|
|
1815
|
+
require 'late-sdk'
|
|
1816
|
+
# setup authorization
|
|
1817
|
+
Late.configure do |config|
|
|
1818
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1819
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1820
|
+
end
|
|
1821
|
+
|
|
1822
|
+
api_instance = Late::WhatsAppApi.new
|
|
1823
|
+
send_whats_app_bulk_request = Late::SendWhatsAppBulkRequest.new({account_id: 'account_id_example', recipients: [Late::SendWhatsAppBulkRequestRecipientsInner.new({phone: 'phone_example'})], template: Late::SendWhatsAppBulkRequestTemplate.new({name: 'name_example', language: 'language_example'})}) # SendWhatsAppBulkRequest |
|
|
1824
|
+
|
|
1825
|
+
begin
|
|
1826
|
+
# Bulk send template messages
|
|
1827
|
+
result = api_instance.send_whats_app_bulk(send_whats_app_bulk_request)
|
|
1828
|
+
p result
|
|
1829
|
+
rescue Late::ApiError => e
|
|
1830
|
+
puts "Error when calling WhatsAppApi->send_whats_app_bulk: #{e}"
|
|
1831
|
+
end
|
|
1832
|
+
```
|
|
1833
|
+
|
|
1834
|
+
#### Using the send_whats_app_bulk_with_http_info variant
|
|
1835
|
+
|
|
1836
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1837
|
+
|
|
1838
|
+
> <Array(<SendWhatsAppBulk200Response>, Integer, Hash)> send_whats_app_bulk_with_http_info(send_whats_app_bulk_request)
|
|
1839
|
+
|
|
1840
|
+
```ruby
|
|
1841
|
+
begin
|
|
1842
|
+
# Bulk send template messages
|
|
1843
|
+
data, status_code, headers = api_instance.send_whats_app_bulk_with_http_info(send_whats_app_bulk_request)
|
|
1844
|
+
p status_code # => 2xx
|
|
1845
|
+
p headers # => { ... }
|
|
1846
|
+
p data # => <SendWhatsAppBulk200Response>
|
|
1847
|
+
rescue Late::ApiError => e
|
|
1848
|
+
puts "Error when calling WhatsAppApi->send_whats_app_bulk_with_http_info: #{e}"
|
|
1849
|
+
end
|
|
1850
|
+
```
|
|
1851
|
+
|
|
1852
|
+
### Parameters
|
|
1853
|
+
|
|
1854
|
+
| Name | Type | Description | Notes |
|
|
1855
|
+
| ---- | ---- | ----------- | ----- |
|
|
1856
|
+
| **send_whats_app_bulk_request** | [**SendWhatsAppBulkRequest**](SendWhatsAppBulkRequest.md) | | |
|
|
1857
|
+
|
|
1858
|
+
### Return type
|
|
1859
|
+
|
|
1860
|
+
[**SendWhatsAppBulk200Response**](SendWhatsAppBulk200Response.md)
|
|
1861
|
+
|
|
1862
|
+
### Authorization
|
|
1863
|
+
|
|
1864
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1865
|
+
|
|
1866
|
+
### HTTP request headers
|
|
1867
|
+
|
|
1868
|
+
- **Content-Type**: application/json
|
|
1869
|
+
- **Accept**: application/json
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
## update_whats_app_business_profile
|
|
1873
|
+
|
|
1874
|
+
> <UnpublishPost200Response> update_whats_app_business_profile(update_whats_app_business_profile_request)
|
|
1875
|
+
|
|
1876
|
+
Update business profile
|
|
1877
|
+
|
|
1878
|
+
Update the WhatsApp Business profile. All fields are optional; only provided fields will be updated. Constraints: about max 139 chars, description max 512 chars, max 2 websites.
|
|
1879
|
+
|
|
1880
|
+
### Examples
|
|
1881
|
+
|
|
1882
|
+
```ruby
|
|
1883
|
+
require 'time'
|
|
1884
|
+
require 'late-sdk'
|
|
1885
|
+
# setup authorization
|
|
1886
|
+
Late.configure do |config|
|
|
1887
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1888
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1889
|
+
end
|
|
1890
|
+
|
|
1891
|
+
api_instance = Late::WhatsAppApi.new
|
|
1892
|
+
update_whats_app_business_profile_request = Late::UpdateWhatsAppBusinessProfileRequest.new({account_id: 'account_id_example'}) # UpdateWhatsAppBusinessProfileRequest |
|
|
1893
|
+
|
|
1894
|
+
begin
|
|
1895
|
+
# Update business profile
|
|
1896
|
+
result = api_instance.update_whats_app_business_profile(update_whats_app_business_profile_request)
|
|
1897
|
+
p result
|
|
1898
|
+
rescue Late::ApiError => e
|
|
1899
|
+
puts "Error when calling WhatsAppApi->update_whats_app_business_profile: #{e}"
|
|
1900
|
+
end
|
|
1901
|
+
```
|
|
1902
|
+
|
|
1903
|
+
#### Using the update_whats_app_business_profile_with_http_info variant
|
|
1904
|
+
|
|
1905
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1906
|
+
|
|
1907
|
+
> <Array(<UnpublishPost200Response>, Integer, Hash)> update_whats_app_business_profile_with_http_info(update_whats_app_business_profile_request)
|
|
1908
|
+
|
|
1909
|
+
```ruby
|
|
1910
|
+
begin
|
|
1911
|
+
# Update business profile
|
|
1912
|
+
data, status_code, headers = api_instance.update_whats_app_business_profile_with_http_info(update_whats_app_business_profile_request)
|
|
1913
|
+
p status_code # => 2xx
|
|
1914
|
+
p headers # => { ... }
|
|
1915
|
+
p data # => <UnpublishPost200Response>
|
|
1916
|
+
rescue Late::ApiError => e
|
|
1917
|
+
puts "Error when calling WhatsAppApi->update_whats_app_business_profile_with_http_info: #{e}"
|
|
1918
|
+
end
|
|
1919
|
+
```
|
|
1920
|
+
|
|
1921
|
+
### Parameters
|
|
1922
|
+
|
|
1923
|
+
| Name | Type | Description | Notes |
|
|
1924
|
+
| ---- | ---- | ----------- | ----- |
|
|
1925
|
+
| **update_whats_app_business_profile_request** | [**UpdateWhatsAppBusinessProfileRequest**](UpdateWhatsAppBusinessProfileRequest.md) | | |
|
|
1926
|
+
|
|
1927
|
+
### Return type
|
|
1928
|
+
|
|
1929
|
+
[**UnpublishPost200Response**](UnpublishPost200Response.md)
|
|
1930
|
+
|
|
1931
|
+
### Authorization
|
|
1932
|
+
|
|
1933
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1934
|
+
|
|
1935
|
+
### HTTP request headers
|
|
1936
|
+
|
|
1937
|
+
- **Content-Type**: application/json
|
|
1938
|
+
- **Accept**: application/json
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
## update_whats_app_contact
|
|
1942
|
+
|
|
1943
|
+
> <UpdateWhatsAppContact200Response> update_whats_app_contact(contact_id, update_whats_app_contact_request)
|
|
1944
|
+
|
|
1945
|
+
Update contact
|
|
1946
|
+
|
|
1947
|
+
Update an existing WhatsApp contact. All fields are optional; only provided fields will be updated. Custom fields are merged with existing values. Set a custom field to null to remove it.
|
|
1948
|
+
|
|
1949
|
+
### Examples
|
|
1950
|
+
|
|
1951
|
+
```ruby
|
|
1952
|
+
require 'time'
|
|
1953
|
+
require 'late-sdk'
|
|
1954
|
+
# setup authorization
|
|
1955
|
+
Late.configure do |config|
|
|
1956
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
1957
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1958
|
+
end
|
|
1959
|
+
|
|
1960
|
+
api_instance = Late::WhatsAppApi.new
|
|
1961
|
+
contact_id = 'contact_id_example' # String | Contact ID
|
|
1962
|
+
update_whats_app_contact_request = Late::UpdateWhatsAppContactRequest.new # UpdateWhatsAppContactRequest |
|
|
1963
|
+
|
|
1964
|
+
begin
|
|
1965
|
+
# Update contact
|
|
1966
|
+
result = api_instance.update_whats_app_contact(contact_id, update_whats_app_contact_request)
|
|
1967
|
+
p result
|
|
1968
|
+
rescue Late::ApiError => e
|
|
1969
|
+
puts "Error when calling WhatsAppApi->update_whats_app_contact: #{e}"
|
|
1970
|
+
end
|
|
1971
|
+
```
|
|
1972
|
+
|
|
1973
|
+
#### Using the update_whats_app_contact_with_http_info variant
|
|
1974
|
+
|
|
1975
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1976
|
+
|
|
1977
|
+
> <Array(<UpdateWhatsAppContact200Response>, Integer, Hash)> update_whats_app_contact_with_http_info(contact_id, update_whats_app_contact_request)
|
|
1978
|
+
|
|
1979
|
+
```ruby
|
|
1980
|
+
begin
|
|
1981
|
+
# Update contact
|
|
1982
|
+
data, status_code, headers = api_instance.update_whats_app_contact_with_http_info(contact_id, update_whats_app_contact_request)
|
|
1983
|
+
p status_code # => 2xx
|
|
1984
|
+
p headers # => { ... }
|
|
1985
|
+
p data # => <UpdateWhatsAppContact200Response>
|
|
1986
|
+
rescue Late::ApiError => e
|
|
1987
|
+
puts "Error when calling WhatsAppApi->update_whats_app_contact_with_http_info: #{e}"
|
|
1988
|
+
end
|
|
1989
|
+
```
|
|
1990
|
+
|
|
1991
|
+
### Parameters
|
|
1992
|
+
|
|
1993
|
+
| Name | Type | Description | Notes |
|
|
1994
|
+
| ---- | ---- | ----------- | ----- |
|
|
1995
|
+
| **contact_id** | **String** | Contact ID | |
|
|
1996
|
+
| **update_whats_app_contact_request** | [**UpdateWhatsAppContactRequest**](UpdateWhatsAppContactRequest.md) | | |
|
|
1997
|
+
|
|
1998
|
+
### Return type
|
|
1999
|
+
|
|
2000
|
+
[**UpdateWhatsAppContact200Response**](UpdateWhatsAppContact200Response.md)
|
|
2001
|
+
|
|
2002
|
+
### Authorization
|
|
2003
|
+
|
|
2004
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2005
|
+
|
|
2006
|
+
### HTTP request headers
|
|
2007
|
+
|
|
2008
|
+
- **Content-Type**: application/json
|
|
2009
|
+
- **Accept**: application/json
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
## update_whats_app_template
|
|
2013
|
+
|
|
2014
|
+
> <UpdateWhatsAppTemplate200Response> update_whats_app_template(template_name, update_whats_app_template_request)
|
|
2015
|
+
|
|
2016
|
+
Update template
|
|
2017
|
+
|
|
2018
|
+
Update a message template's components. Only certain fields can be updated depending on the template's current approval state. Approved templates can only have components updated.
|
|
2019
|
+
|
|
2020
|
+
### Examples
|
|
2021
|
+
|
|
2022
|
+
```ruby
|
|
2023
|
+
require 'time'
|
|
2024
|
+
require 'late-sdk'
|
|
2025
|
+
# setup authorization
|
|
2026
|
+
Late.configure do |config|
|
|
2027
|
+
# Configure Bearer authorization (JWT): bearerAuth
|
|
2028
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2029
|
+
end
|
|
2030
|
+
|
|
2031
|
+
api_instance = Late::WhatsAppApi.new
|
|
2032
|
+
template_name = 'template_name_example' # String | Template name
|
|
2033
|
+
update_whats_app_template_request = Late::UpdateWhatsAppTemplateRequest.new({account_id: 'account_id_example', components: [3.56]}) # UpdateWhatsAppTemplateRequest |
|
|
2034
|
+
|
|
2035
|
+
begin
|
|
2036
|
+
# Update template
|
|
2037
|
+
result = api_instance.update_whats_app_template(template_name, update_whats_app_template_request)
|
|
2038
|
+
p result
|
|
2039
|
+
rescue Late::ApiError => e
|
|
2040
|
+
puts "Error when calling WhatsAppApi->update_whats_app_template: #{e}"
|
|
2041
|
+
end
|
|
2042
|
+
```
|
|
2043
|
+
|
|
2044
|
+
#### Using the update_whats_app_template_with_http_info variant
|
|
2045
|
+
|
|
2046
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2047
|
+
|
|
2048
|
+
> <Array(<UpdateWhatsAppTemplate200Response>, Integer, Hash)> update_whats_app_template_with_http_info(template_name, update_whats_app_template_request)
|
|
2049
|
+
|
|
2050
|
+
```ruby
|
|
2051
|
+
begin
|
|
2052
|
+
# Update template
|
|
2053
|
+
data, status_code, headers = api_instance.update_whats_app_template_with_http_info(template_name, update_whats_app_template_request)
|
|
2054
|
+
p status_code # => 2xx
|
|
2055
|
+
p headers # => { ... }
|
|
2056
|
+
p data # => <UpdateWhatsAppTemplate200Response>
|
|
2057
|
+
rescue Late::ApiError => e
|
|
2058
|
+
puts "Error when calling WhatsAppApi->update_whats_app_template_with_http_info: #{e}"
|
|
2059
|
+
end
|
|
2060
|
+
```
|
|
2061
|
+
|
|
2062
|
+
### Parameters
|
|
2063
|
+
|
|
2064
|
+
| Name | Type | Description | Notes |
|
|
2065
|
+
| ---- | ---- | ----------- | ----- |
|
|
2066
|
+
| **template_name** | **String** | Template name | |
|
|
2067
|
+
| **update_whats_app_template_request** | [**UpdateWhatsAppTemplateRequest**](UpdateWhatsAppTemplateRequest.md) | | |
|
|
2068
|
+
|
|
2069
|
+
### Return type
|
|
2070
|
+
|
|
2071
|
+
[**UpdateWhatsAppTemplate200Response**](UpdateWhatsAppTemplate200Response.md)
|
|
2072
|
+
|
|
2073
|
+
### Authorization
|
|
2074
|
+
|
|
2075
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2076
|
+
|
|
2077
|
+
### HTTP request headers
|
|
2078
|
+
|
|
2079
|
+
- **Content-Type**: application/json
|
|
2080
|
+
- **Accept**: application/json
|
|
2081
|
+
|