Skip to content

For partners#

For questions about joining the partner scheme and additional terms, please write to support@green-api.com or in the chat on the website.

The partner scheme implies a deeper integration with the service and working with a large number of instances on your side:

  • Managing instances both in the console and through the API

  • Postpaid system (from the second month of work)

  • Continuous operation of instances even with a negative balance (including creating new instances)

  • Daily billing (for instances that have been created and not deleted)

  • Dedicated support line

When is the payment charged?

The payment for a partner instance is charged at 00:00 UTC+3:00.

To determine the type of your console, go to the Profile tab -> Account information -> Account type -> Partner

Setting up the Telegram messenger API for partners:

  1. Getting a partner key
  2. Preparing and working with the partner console
  3. Paying for a partner instance
  4. Request format
  5. API methods available to partners
  6. Workflow

1. Getting a partner key#

A partner API key is obtained through the GREEN-API technical support at support@green-api.com.

Before requesting a partner key, we recommend reading the Preparing and working with the partner console section

2. Preparing and working with the partner console#

  • To work with partner instances, we recommend creating a separate console account. Register the account with a corporate email, so that you do not lose the console data when an employee leaves.

  • After the console is switched to working with the partner program (you are issued a partner key), creating and deleting instances is done through the API or in the console.

  • If you have instances on the Business plan in your console, they will be billed under the standard scheme (an instance may expire and it has to be renewed by paying on the website); it is impossible to change their billing to the partner one.

  • We recommend that after receiving the partner key you delete all existing instances from the console and create instances through the API.

  • For testing and configuring the integration, a developer must use a separate console account and instances on the Developer plan. The quota for creating instances is increased through the technical support channel.

3. Paying for a partner instance#

A postpaid system applies to an instance on the Partner plan. Partners do not need to monitor their balance.

If the balance goes negative, the instances will continue to work as usual.
Creating instances is also possible even with a negative balance (the payment for an instance is charged from the balance upon creation, and after that daily at 00:00, utc +3).

Every month we send out billing statements with a breakdown by instance. Then we issue an invoice if you pay by invoice.
The invoice for the previous month must be paid before the 15th of the month following the reporting one.

4. Request format#

The API is accessed at: 

{{partnerApiUrl}}/partner/{method}/{{partnerToken}}

5. API methods available to partners#

GetInstances - the method returns the list of all instances created on the partner account

CreateInstance - the method creates a new instance on the partner account

DeleteInstanceAccount - the method deletes an instance of the partner account

6. Workflow#

  1. Create an instance using the CreateInstance method or manually in the console.

  2. Authorize the new instance on the phone. To do this, go to the console.

The instance is ready for work. To send and receive messages, use the API methods according to the documentation