@brvhprince/termii-js

/** * Project: termii-js * File: messaging * Created by pennycodes on 25/04/2023. * Copyright termii-js */ import { KeyValuePair, Paginator, Paginator2 } from "./global"; interface SenderID { sender_id: string; status: "block" | "unblock"; company: string | null; usecase: string | null; country: string | null; created_at: string; } export interface SenderIDs extends Paginator<SenderID> { } export interface RequestSenderIdOptions { /** * Represents the ID of the sender which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters * Example: CompanyName */ sender_id: string; /** A sample of the type of message sent */ usecase: string; /** Represents the name of the company with the sender ID */ company: string; } export interface RequestSenderIdPayload extends RequestSenderIdOptions { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; } export declare const enum MessagingChannels { /** * This channel is used to send promotional messages and messages to phone number not on dnd */ GENERIC = "generic", /** * On this channel all your messages deliver whether there is [dnd restriction]{@link https://termii.medium.com/the-dnd-service-in-nigeria-everything-you-need-to-know-72b7247e3968} or not on the phone number */ DND = "dnd", /** * This channel sends messages via WhatsApp */ WHATSAPP = "whatsapp" } interface MediaOptions { /** * The url to the file resource * <h3> Media Types </h3> * <tr> * <th> File * </th> * <th> Supported Format * </th> * </tr> * <tr> * <td>Image</td> * <td> JPG, JPEG, PNG </td> * </tr> * <tr> * <td> Audio </td> * <td> MP3, OGG, AMR </td> * </tr> * <tr> * <td> Documents </td> * <td> PDF </td> * </tr> * <tr> * <td> Video </td> * <td> MP4 (Note: WhatsApp currently does not support MP4 files without an audio) </td> * </tr> */ url: string; /** * The caption that should be added to the image. */ caption: string; } export interface SendMessageOptions { /** * Represents the destination phone number. Phone number must be in the international format * (Example: 23490126727) * You can also send to multiple numbers. To do so put numbers in an array * (Example: ["23490555546", "23423490126999"]) * Please note: the array takes only 100 phone numbers at a time */ to: string | string[]; /** * Text of a message that would be sent to the destination phone number */ sms: string; /** * The kind of message that is sent, which is a plain message * <h3> Default is plain </h3> */ type?: string; /** * This is the route through which the message is sent. It is either dnd, whatsapp, or generic * <h3> Default is generic </h3> */ channel?: MessagingChannels; /** * This is a media object, it is only available for the High Volume WhatsApp */ media?: MediaOptions; } export interface SendMessagePayload extends SendMessageOptions { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; type: string; channel: MessagingChannels; /** * Represents a sender ID for sms which can be Alphanumeric or Device name for Whatsapp * Alphanumeric sender ID length should be between 3 and 11 characters * (Example:CompanyName) */ from: string; } export interface SendBulkMessageOptions { /** * Represents the array of phone numbers you are sending to * (Example: ["23490555546", "23423490126999","23490555546"]). * Phone numbers must be in international format (Example: 23490126727) * lease note: the array can take up to 10,000 phone numbers */ to: string[]; /** * Text of a message that would be sent to the destination phone number */ sms: string; /** * The kind of message that is sent, which is a plain message * <h3> Default is plain </h3> */ type?: string; /** * This is the route through which the message is sent. It is either dnd, whatsapp, or generic * <h3> Default is generic </h3> */ channel?: MessagingChannels; } export interface SendBulkMessagePayload extends SendBulkMessageOptions { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; type: string; channel: MessagingChannels; /** * Represents a sender ID for sms which can be Alphanumeric or Device name for Whatsapp * Alphanumeric sender ID length should be between 3 and 11 characters * (Example:CompanyName) */ from: string; } export interface SendWithoutSenderId { /** * Represents the destination phone number. Phone number must be in the international format * (Example: 2349012672711) */ to: string; /** * Text of a message that would be sent to the destination phone number */ sms: string; } export interface SendWithoutSenderIdPayload extends SendWithoutSenderId { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; } export interface SendMessageResponse { code: string; message_id: string; message: string; balance: number | string; user: string; } export interface SendTemplateOptions { /** * The destination phone number. Phone number must be in the international format * (Example: 23490126727) */ phone_number: string; /** * Represents the Device ID for Whatsapp. It can be Alphanumeric * It should be passed when the message is sent via whatsapp (It can be found on the manage device page on your Termii dashboard) */ device_id: string; /** * The ID of the template used */ template_id: string; /** * Represents an object of key: value pair. * The keys for the data object can be found on the device subscription page on your dashboard * (Example: {"product_name": "Termii", "otp" : 120435, }) */ data: KeyValuePair; } export interface SendTemplatePayload extends SendTemplateOptions { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; } interface Phonebook { id: string; name: string; total_number_of_contacts: string; date_created: string; last_updated: string; } export interface Phonebooks extends Paginator2<Phonebook> { } export interface CreatePhonebook { /** * The name of the phonebook */ phonebook_name: string; /** * A description of the contacts stored in the phonebook */ description?: string; } export interface AddPhonebook extends CreatePhonebook { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; } export interface UpdatePhonebook { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; /** * The name of the phonebook */ phonebook_name: string; } interface Contact { id: string | number; pid: string | number; phone_number: string; email_address: string | null; message: string | null; company: string | null; first_name: string | null; last_name: string | null; create_at: string | null; updated_at: string | null; } export interface Contacts extends Paginator2<Contact> { } export interface CreateContact { /** * Phone number of the contact */ phone_number: string; /** * Represents short numeric geographical codes developed to represent countries * (Example: 234 ) */ country_code?: string | number; /** * email address of the contact */ email_address?: string; /** * first name of the contact */ first_name?: string; /** * last name of the contact */ last_name?: string; /** * name of the company of the contact */ company?: string; } export interface AddContact extends CreateContact { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; } export interface ContactResponse { data: { id: number; phone_number: string; email_address: string; message: string | null; company: string; first_name: string; last_name: string; create_at: string; updated_at: string; }; } export interface SendCampaignOptions { /** * Represents short numeric geographical codes developed to represent countries * (Example: 234 ) . */ country_code: string; /** * Text of a message that would be sent to the destination phone number */ message: string; /** * This is the route through which the message is sent. It is either dnd, whatsapp, or generic * <h3> Default is generic </h3> */ channel?: MessagingChannels; /** * The type of message that is sent, which is a plain message. * <h3> Default is plain </h3> */ message_type?: string; /** * ID of the phonebook selected */ phonebook_id: string; /** * Represents type of campaign */ campaign_type: string; schedule_sms_status?: "scheduled"; /** * The time to send scheduled campaign. * This is required if scheduled_sm_status is scheduled * Example 30-06-2021 6:00 */ schedule_time?: string; /** * Remove duplicates contact numbers * <h3> Default is yes </h3> */ remove_duplicate?: "yes" | "no"; } export interface SendCampaignPayload extends SendCampaignOptions { /** Your API key (It can be found on your [Termii Dashboard]{@link https://accounts.termii.com/#/}). */ api_key: string; /** * Represents the ID of the sender which can be alphanumeric or numeric. Alphanumeric sender ID length should be between 3 and 11 characters * Example: CompanyName */ sender_id: string; message_type: string; channel: MessagingChannels; remove_duplicate: "yes" | "no"; } interface Campaign { campaign_id: string; phone_book: string; sender: string; camp_type: string; channel: string; total_recipients: number; run_at: string; status: string; created_at: string; } export interface Campaigns extends Paginator2<Campaign> { } interface History { id: number; sender: string; receiver: string; message: string; message_abbreviation: string; amount: number; channel: string; sms_type: string; message_id: string; status: string; date_created: string; last_updated: string; } export interface CampaignHistory extends Paginator2<History> { } export {};