1.12.2 • Published 1 month ago
@ycloud-cpaas/ycloud-sdk-node v1.12.2
YCloud SDK for Node.js
YCloud API
- API version: v2
The YCloud API is organized around REST. Our API is designed to have predictable, resource-oriented URLs, return JSON responses, and use standard HTTP response codes and verbs.
Requirements
Node 8 or higher.
Installation
npm install @ycloud-cpaas/ycloud-sdk-node
Getting Started
Usage with TypeScript
Please follow the installation instruction and execute the following code:
import * as ycloud from '@ycloud-cpaas/ycloud-sdk-node'
const configuration = new ycloud.Configuration({apiKey: 'YOUR_API_KEY'});
const api = new ycloud.BalanceApi(configuration);
api.retrieve()
.then(value => {
console.log('API called successfully. Returned data:', value.data);
})
.catch(reason => {
console.error(reason.response.data);
});
Documentation for API Endpoints
All URIs are relative to https://api.ycloud.com/v2
Class | Method | HTTP request | Description |
---|---|---|---|
BalanceApi | retrieve | GET /balance | Retrieve balance |
ContactsApi | create | POST /contact/contacts | Create a contact |
ContactsApi | delete | DELETE /contact/contacts/{id} | Delete a contact |
ContactsApi | list | GET /contact/contacts | List contacts |
ContactsApi | retrieve | GET /contact/contacts/{id} | Retrieve a contact |
ContactsApi | update | PATCH /contact/contacts/{id} | Update a contact |
EmailsApi | send | POST /emails | Send an email |
SmsApi | list | GET /sms | List SMS records |
SmsApi | send | POST /sms | Send an SMS |
UnsubscribersApi | create | POST /unsubscribers | Create an unsubscriber |
UnsubscribersApi | deleteByCustomerAndChannel | DELETE /unsubscribers/{customer}/{channel} | Delete an unsubscriber |
UnsubscribersApi | list | GET /unsubscribers | List unsubscribers |
UnsubscribersApi | listAllByCustomer | GET /unsubscribers/{customer} | List all unsubscribers by customer |
UnsubscribersApi | retrieveByCustomerAndChannel | GET /unsubscribers/{customer}/{channel} | Retrieve an unsubscriber |
VerifyApi | check | POST /verify/verificationChecks | Check a verification |
VerifyApi | send | POST /verify/verifications | Start a verification |
VoicesApi | list | GET /voices | List voice records |
VoicesApi | send | POST /voices | Send a voice code |
WebhookEndpointsApi | create | POST /webhookEndpoints | Create a webhook endpoint |
WebhookEndpointsApi | delete | DELETE /webhookEndpoints/{id} | Delete a webhook endpoint |
WebhookEndpointsApi | list | GET /webhookEndpoints | List webhook endpoints |
WebhookEndpointsApi | retrieve | GET /webhookEndpoints/{id} | Retrieve a webhook endpoint |
WebhookEndpointsApi | rotateSecret | POST /webhookEndpoints/{id}/rotateSecret | Rotate a webhook endpoint secret |
WebhookEndpointsApi | update | PATCH /webhookEndpoints/{id} | Update a webhook endpoint |
WhatsappBusinessAccountsApi | list | GET /whatsapp/businessAccounts | List WABAs |
WhatsappBusinessAccountsApi | retrieve | GET /whatsapp/businessAccounts/{id} | Retrieve a WABA |
WhatsappInboundMessagesApi | markAsRead | POST /whatsapp/inboundMessages/{id}/markAsRead | Mark message as read |
WhatsappMessagesApi | retrieve | GET /whatsapp/messages/{id} | Retrieve a message |
WhatsappMessagesApi | send | POST /whatsapp/messages | Enqueue a message |
WhatsappMessagesApi | sendDirectly | POST /whatsapp/messages/sendDirectly | Send a message directly |
WhatsappPhoneNumbersApi | list | GET /whatsapp/phoneNumbers | List phone numbers |
WhatsappPhoneNumbersApi | register | POST /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/register | Register a phone number |
WhatsappPhoneNumbersApi | retrieve | GET /whatsapp/phoneNumbers/{wabaId}/{phoneNumber} | Retrieve a phone number |
WhatsappPhoneNumbersApi | retrieveCommerceSettings | GET /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/whatsappCommerceSettings | Retrieve commerce settings |
WhatsappPhoneNumbersApi | retrieveProfile | GET /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/profile | Retrieve a phone number profile |
WhatsappPhoneNumbersApi | updateCommerceSettings | PATCH /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/whatsappCommerceSettings | Update commerce settings |
WhatsappPhoneNumbersApi | updateProfile | PATCH /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/profile | Update a phone number profile |
WhatsappTemplatesApi | create | POST /whatsapp/templates | Create a template |
WhatsappTemplatesApi | deleteByName | DELETE /whatsapp/templates/{wabaId}/{name} | Delete templates by name |
WhatsappTemplatesApi | deleteByNameAndLanguage | DELETE /whatsapp/templates/{wabaId}/{name}/{language} | Delete a template |
WhatsappTemplatesApi | editByNameAndLanguage | PATCH /whatsapp/templates/{wabaId}/{name}/{language} | Edit a template |
WhatsappTemplatesApi | list | GET /whatsapp/templates | List templates |
WhatsappTemplatesApi | retrieveByNameAndLanguage | GET /whatsapp/templates/{wabaId}/{name}/{language} | Retrieve a template |
Documentation for Authorization
Authentication schemes defined for the API:
api_key
- Type: API key
- API key parameter name: X-API-Key
- Location: HTTP header
1.12.2
1 month ago
1.12.1
3 months ago
1.12.0
3 months ago
1.11.2
4 months ago
1.11.1
4 months ago
1.11.0
5 months ago
1.10.3
6 months ago
1.10.2
6 months ago
1.9.1
8 months ago
1.9.0
8 months ago
1.8.3
11 months ago
1.10.1
7 months ago
1.10.0
7 months ago
1.8.2
12 months ago
1.8.1
1 year ago
1.8.0
1 year ago
1.7.0
1 year ago
1.6.1
1 year ago
1.6.0
1 year ago
1.5.0
1 year ago
1.4.4
1 year ago
1.4.3
1 year ago
1.4.1
1 year ago
1.4.0
1 year ago
1.3.0
1 year ago
1.2.0
2 years ago
1.1.0
2 years ago
1.0.0
2 years ago