API

Every whatsapp.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.

Business Profiles

get

businessProfiles.get Retrieve WhatsApp Business Profile information Risk: read

await corsair.whatsapp.api.businessProfiles.get({});

Input

Name	Type	Required	Description
`phoneNumberId`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  about?: string,
  address?: string,
  description?: string,
  email?: string,
  profile_picture_url?: string,
  websites?: string[],
  vertical?: string
}[]

Media

getInfo

media.getInfo Get information about uploaded media Risk: read

await corsair.whatsapp.api.media.getInfo({});

Input

Name	Type	Required	Description
`mediaId`	`string`	Yes	—

Output

Name	Type	Required	Description
`messaging_product`	`whatsapp`	Yes	—
`url`	`string`	Yes	—
`mime_type`	`string`	Yes	—
`sha256`	`string`	Yes	—
`file_size`	`number`	No	—
`id`	`string`	Yes	—

upload

media.upload Upload media to WhatsApp servers Risk: write

await corsair.whatsapp.api.media.upload({});

Input

Name	Type	Required	Description
`phoneNumberId`	`string`	No	—
`file`	`string`	Yes	—
`type`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

Messages

markRead

messages.markRead Mark an incoming WhatsApp message as read Risk: write

await corsair.whatsapp.api.messages.markRead({});

Input

Name	Type	Required	Description
`phoneNumberId`	`string`	No	—
`messageId`	`string`	Yes	—

Output

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

send

messages.send Send a text, media, template, or interactive WhatsApp message Risk: write

await corsair.whatsapp.api.messages.send({});

Input: object

Input full type

{
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: text,
  text: {
    preview_url?: boolean,
    body: string
  }
} | {
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: image,
  image: {
    id?: string,
    link?: string,
    caption?: string,
    filename?: string
  }
} | {
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: audio,
  audio: {
    id?: string,
    link?: string
  }
} | {
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: document,
  document: {
    id?: string,
    link?: string,
    caption?: string,
    filename?: string
  }
} | {
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: video,
  video: {
    id?: string,
    link?: string,
    caption?: string
  }
} | {
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: template,
  template: {
    name: string,
    language: {
      code: string,
      policy?: deterministic
    },
    components?: {
    }[]
  }
} | {
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: interactive,
  interactive: {
    type: button | list | product | product_list | flow,
    body?: {
      text?: string
    }
  }
} | {
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: location,
  location: {
    longitude: number,
    latitude: number,
    name?: string,
    address?: string
  }
} | {
  phoneNumberId?: string,
  messaging_product: whatsapp,
  recipient_type?: individual,
  to: string,
  context?: {
    message_id: string
  },
  type: contacts,
  contacts: {
    name: {
      formatted_name: string,
      first_name?: string
    },
    phones?: {
      phone?: string,
      type?: string,
      wa_id?: string
    }[]
  }[]
}

Output

Name	Type	Required	Description
`messaging_product`	`whatsapp`	Yes	—
`contacts`	`object[]`	Yes	—
`messages`	`object[]`	Yes	—

contacts full type

{
  input: string,
  wa_id: string
}[]

messages full type

{
  id: string,
  message_status?: string
}[]

Message Templates

create

messageTemplates.create Create a new message template Risk: write

await corsair.whatsapp.api.messageTemplates.create({});

Input

Name	Type	Required	Description
`businessAccountId`	`string`	No	—
`name`	`string`	Yes	—
`language`	`string`	Yes	—
`category`	`string`	Yes	—
`components`	`object[]`	Yes	—

components full type

{
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`string`	No	—
`category`	`string`	No	—

delete

messageTemplates.delete Delete a message template by name Risk: write

await corsair.whatsapp.api.messageTemplates.delete({});

Input

Name	Type	Required	Description
`businessAccountId`	`string`	No	—
`name`	`string`	Yes	—

Output

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

getStatus

messageTemplates.getStatus Get the status of a message template Risk: read

await corsair.whatsapp.api.messageTemplates.getStatus({});

Input

Name	Type	Required	Description
`businessAccountId`	`string`	No	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
}[]

list

messageTemplates.list List all message templates Risk: read

await corsair.whatsapp.api.messageTemplates.list({});

Input

Name	Type	Required	Description
`businessAccountId`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
}[]

Phone Numbers

get

phoneNumbers.get Validate credentials and retrieve phone number health Risk: read

await corsair.whatsapp.api.phoneNumbers.get({});

Input

Name	Type	Required	Description
`phoneNumberId`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`display_phone_number`	`string`	No	—
`verified_name`	`string`	No	—
`quality_rating`	`string`	No	—
`code_verification_status`	`string`	No	—
`platform_type`	`string`	No	—
`throughput`	`object`	No	—

throughput full type

{
  level?: string
}

list

phoneNumbers.list List all phone numbers for the WhatsApp Business Account Risk: read

await corsair.whatsapp.api.phoneNumbers.list({});

Input

Name	Type	Required	Description
`businessAccountId`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—

data full type

{
  id: string,
  display_phone_number?: string,
  verified_name?: string,
  quality_rating?: string,
  code_verification_status?: string,
  platform_type?: string,
  throughput?: {
  }
}[]

Overview

Plugins

Business Profiles

get

Media

getInfo

upload

Messages

markRead

send

Message Templates

create

delete

getStatus

list

Phone Numbers

get

list

​Business Profiles

​get

​Media

​getInfo

​upload

​Messages

​markRead

​send

​Message Templates

​create

​delete

​getStatus

​list

​Phone Numbers

​get

​list

Business Profiles

get

Media

getInfo

upload

Messages

markRead

send

Message Templates

create

delete

getStatus

list

Phone Numbers

get

list