Whatsapp | PortSIP Knowledge Base

PortSIP Knowledge Base

PreviousDestroy NextDestroy

Was this helpful?

List WhatsApp services.

Retrieve a collection of WhatsApp services.

get

/whatsapp

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32 · default: 0

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/whatsapp' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "enabled": true,
      "phone_number": "text",
      "phone_number_id": "text",
      "provider_name": "text",
      "provider_brand": "text",
      "webhook": "text",
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "provider_hostname": "text"
    }
  ]
}

Create WhatsApp service

Create WhatsApp service.

post

/whatsapp

Authorizations

Body

namestring · min: 1 · max: 64required

The name of WhatsApp service.

enabledboolean · default: true

The flag for whether the WhatsApp service is enabled.

phone_numberstring

The phone number of WhatsApp service.

phone_number_idstringrequired

The phone number id of WhatsApp service.

tokenstringrequired

The token of WhatsApp service.

provider_idall ofrequired

The unique ID of trunk.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/whatsapp' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "phone_number": "text",
    "phone_number_id": "text",
    "token": "text",
    "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
  }'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve a WhatsApp service

Retrieve a WhatsApp service.

get

/whatsapp/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of WhatsApp service.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/whatsapp/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "enabled": true,
  "phone_number": "text",
  "phone_number_id": "text",
  "provider_name": "text",
  "provider_brand": "text",
  "webhook": "text",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "provider_hostname": "text"
}

Update the WhatsApp service

Update the WhatsApp service.

post

/whatsapp/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of WhatsApp service.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64

The name of WhatsApp service.

enabledboolean · default: true

The flag for whether the WhatsApp service is enabled.

phone_numberstring

The phone number of WhatsApp service.

phone_number_idstring

The phone number id of WhatsApp service.

tokenstring

The token of WhatsApp service.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/whatsapp/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "enabled": true,
    "phone_number": "text",
    "phone_number_id": "text",
    "token": "text"
  }'

200

4XX

No body