API

Every twochat.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Account

getApiUsageInfo

account.getApiUsageInfo Retrieve current API usage and account information. Use when you need to monitor your remaining quotas before sending more requests. Risk: read

await corsair.twochat.api.account.getApiUsageInfo({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`account`	`object`	No	—
`limits`	`object`	No	—
`usage`	`object`	No	—

account full type

{
  name?: string,
  uuid?: string,
  on_trial?: boolean,
  blocked?: boolean,
  created_at?: string,
  expires_at?: string
}

limits full type

{
  requests_per_minute?: number
}

usage full type

{
  api_request_count?: number,
  max_api_request_count?: number,
  number_check_count?: number,
  max_number_check_count?: number
}

testApiKey

account.testApiKey Validate your API key and retrieve account info. Use when confirming credentials before performing other operations. Risk: read

await corsair.twochat.api.account.testApiKey({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`account`	`object`	No	—
`limits`	`object`	No	—
`usage`	`object`	No	—

account full type

{
  name?: string,
  uuid?: string,
  on_trial?: boolean,
  blocked?: boolean,
  created_at?: string,
  expires_at?: string
}

limits full type

{
  requests_per_minute?: number
}

usage full type

{
  api_request_count?: number,
  max_api_request_count?: number,
  number_check_count?: number,
  max_number_check_count?: number
}

Contacts

createContact

contacts.createContact Create a new contact in your 2Chat account. Use after gathering and verifying first name and at least one contact detail (email, phone, or address). Risk: write

await corsair.twochat.api.contacts.createContact({});

Input

Name	Type	Required	Description
`first_name`	`string`	Yes	First name of the new contact
`last_name`	`string`	No	Last name of the new contact
`profile_pic_url`	`string`	No	Publicly accessible URL to the contact profile picture
`channel_uuid`	`string`	No	UUID of a WhatsApp channel — if provided the contact is also created on that WhatsApp account
`contact_details`	`object[]`	Yes	At least one contact detail (email, phone, or address). Required.

contact_details full type

{
  type: E | A | PH | WAPH,
  value: string
}[]

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`contact`	`object`	Yes	—

contact full type

{
  uuid: string,
  first_name: string,
  last_name?: string,
  name?: string,
  channel_uuid?: string | null,
  profile_pic_url?: string | null,
  details?: {
    type: E | A | PH | WAPH,
    value: string,
    id?: number,
    created_at?: string | number,
    updated_at?: string | number
  }[],
  contact_details?: {
    type: E | A | PH | WAPH,
    value: string,
    id?: number,
    created_at?: string | number,
    updated_at?: string | number
  }[],
  last_updated?: string,
  created_at?: string
}

listContacts

contacts.listContacts List all contacts in your 2Chat account. Use when you need to retrieve your contact list after confirming your account connection. Risk: read

await corsair.twochat.api.contacts.listContacts({});

Input

Name	Type	Required	Description
`page_number`	`number`	Yes	Zero-based page number for pagination
`results_per_page`	`number`	Yes	Number of contacts per page (1–100)

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—
`page`	`number`	Yes	—
`count`	`number`	Yes	—
`contacts`	`object[]`	Yes	—

contacts full type

{
  uuid: string,
  first_name: string,
  last_name?: string,
  name?: string,
  channel_uuid?: string | null,
  profile_pic_url?: string | null,
  details?: {
    type: E | A | PH | WAPH,
    value: string,
    id?: number,
    created_at?: string | number,
    updated_at?: string | number
  }[],
  contact_details?: {
    type: E | A | PH | WAPH,
    value: string,
    id?: number,
    created_at?: string | number,
    updated_at?: string | number
  }[],
  last_updated?: string,
  created_at?: string
}[]

Webhook Subscriptions

listWebhooks

webhookSubscriptions.listWebhooks List all configured webhook subscriptions for WhatsApp and phone call events. Returns details including webhook UUID, event type, channel UUID, callback URL, and creation timestamp. Risk: read

await corsair.twochat.api.webhookSubscriptions.listWebhooks({});

Input: empty object Output

Name	Type	Required	Description
`success`	`boolean`	No	—
`webhooks`	`object[]`	Yes	—

webhooks full type

{
  uuid: string,
  event_name: string,
  channel_uuid?: string,
  hook_url: string,
  hook_params?: {
  },
  created_at?: string
}[]

Overview

Plugins

Account

getApiUsageInfo

testApiKey

Contacts

createContact

listContacts

Webhook Subscriptions

listWebhooks

​Account

​getApiUsageInfo

​testApiKey

​Contacts

​createContact

​listContacts

​Webhook Subscriptions

​listWebhooks

Account

getApiUsageInfo

testApiKey

Contacts

createContact

listContacts

Webhook Subscriptions

listWebhooks