واجهة برمجة تطبيقات إدارة Subscriber في WhatChimp

إنشاء وتحديث وحذف subscribers وإدارة Labels برمجياً

Updated 10 February 2026

واجهة برمجة تطبيقات إدارة Subscriber في WhatChimp تمنحك تحكماً كاملاً في قائمة subscribers (جهات الاتصال) الخاصة بك. أنشئ وحدّث واحذف subscribers، وأدر labels والتسلسلات الخاصة بهم، وعيّن custom fields، والمزيد — كل ذلك من خلال طلبات HTTP بسيطة.

قبل البدء: تأكد من أن لديك API key و phone number ID الخاص بك. راجع Getting Started with WhatChimp Developer API للحصول على تعليمات الإعداد.

Video: https://www.youtube.com/watch?v=pYpWuoHSZlk

الحصول على Subscriber

استرجع تفاصيل subscriber محدد من خلال رقم هاتفه.

Endpoint: POST /api/v1/whatsapp/subscriber/get

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/get

Get Subscriber endpoint in the API console showing parameters and sample response

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/get' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER'

Sample Response:

{
  "status": "1",
  "message": [
    {
      "subscriber_id": 144,
      "chat_id": "0123456789",
      "first_name": "john",
      "last_name": "Doe",
      "email": "test@gmail.com",
      "gender": "Male",
      "label_names": "Label1,Label2"
    }
  ]
}

عرض قائمة Subscribers

احصل على قائمة مرقّمة بجميع subscribers الخاصين بك.

Endpoint: GET/POST /api/v1/whatsapp/subscriber/list

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/list

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`limit`	Number	Yes	Number of subscribers to return
`offset`	Number	No	Pagination offset (start from this position)
`orderBy`	Number	No	Set to `1` to sort by most recent message (latest first). Set to `0` for default order.

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1&orderBy=0

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/list' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'limit=10' \
  -d 'offset=1' \
  -d 'orderBy=0'

Sample Response:

{
  "status": "1",
  "message": [
    {
      "subscriber_id": 144,
      "chat_id": "0123456789",
      "first_name": "John",
      "last_name": "Doe",
      "email": "test@gmail.com",
      "gender": "male",
      "label_names": "One,two"
    },
    {
      "subscriber_id": 157,
      "chat_id": "0123456789",
      "first_name": "john",
      "last_name": "Doe",
      "email": null,
      "gender": "Male",
      "label_names": "ChatTest,remove tag,One"
    }
  ]
}

نصيحة: استخدم offset للتنقل عبر قوائم subscribers الكبيرة. على سبيل المثال، احصل على أول 50 باستخدام limit=50&offset=0، ثم الـ 50 التالية باستخدام limit=50&offset=50.

إنشاء Subscriber

أضف subscriber (جهة اتصال) جديد إلى حساب WhatsApp الخاص بك.

Endpoint: POST /api/v1/whatsapp/subscriber/create

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/create

Create Subscriber endpoint in the API console showing parameters and response examples

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phoneNumberID`	String	Yes	Your WhatsApp phone number ID
`name`	String	Yes	Name of the subscriber
`phoneNumber`	String	Yes	Subscriber's phone number with country code (no `+` sign)

ملاحظة: يستخدم هذا الـ endpoint phoneNumberID و phoneNumber (camelCase)، وهو يختلف عن معظم endpoints الأخرى التي تستخدم phone_number_id و phone_number (snake_case).

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/create' \
  -d 'apiToken=API-KEY' \
  -d 'phoneNumberID=PHONE-NUMBER-ID' \
  -d 'name=NAME' \
  -d 'phoneNumber=MOBILE'

Sample Responses:

{"status": "1", "mesasge": "WhatsApp subscriber has been created."}

{"status": "0", "message": "WhatsApp account not found."}

{"status": "0", "message": "Subscriber limit has been exceeded. You cannot have more subscribers."}

{"status": "0", "message": "Something went wrong or subscriber already exist."}

تحديث Subscriber

حدّث تفاصيل subscriber موجود.

Endpoint: POST /api/v1/whatsapp/subscriber/update

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/update

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number
`first_name`	String	No	First name
`last_name`	String	No	Last name
`gender`	String	No	Gender
`label_ids`	String	No	Label IDs, comma-separated (e.g., `1,4,5`)

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/update' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'first_name=FIRST-NAME' \
  -d 'last_name=LAST-NAME' \
  -d 'gender=GENDER' \
  -d 'label_ids=LABEL-IDS'

Sample Response:

{"status": "1", "message": "Subscriber Updated Successfully."}

حذف Subscriber

احذف subscriber من حساب WhatsApp الخاص بك.

Endpoint: GET/POST /api/v1/whatsapp/subscriber/delete

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/delete

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number with country code, numeric only

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/delete' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER'

Sample Response:

{"status": "1", "message": "Subscriber has been deleted successfully."}

عمليات Subscriber المتقدمة

توفر endpoints التالية إمكانيات إضافية لإدارة subscribers. تتبع هذه endpoints نفس نمط المصادقة — قم بتضمين apiToken في كل طلب.

إعادة تعيين User Input Flow

أعد تعيين user input flow الحالي لـ subscriber، مما يسمح له بالبدء من جديد.

Endpoint: GET/POST /api/v1/whatsapp/subscriber/reset/user-input-flow

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/reset/user-input-flow

Reset User Input Flow endpoint in the API console showing the endpoint URL and parameters

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/reset/user-input-flow?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/reset/user-input-flow' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER'

Sample Response:

{"status":"1","message":"Reset User Input Flow successfully."}

تعيين المحادثة لعضو فريق

عيّن محادثة subscriber لعضو فريق محدد للمتابعة.

Endpoint: GET/POST /api/v1/whatsapp/subscriber/chat/assign-to-team-member

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number
`team_member_id`	Integer	Yes	ID of the team member to assign

GET Request:

https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&team_member_id=TEAM-MEMBER-ID

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'team_member_id=TEAM-MEMBER-ID'

Sample Response:

{"status":"1","message":"Successfully Assign Agent to Conversation."}

تعيين Custom Fields

عيّن قيم custom fields لـ subscriber.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/assign-custom-fields

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-custom-fields

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number
`custom_fields`	JSON	Yes	Custom field names and values as JSON object (e.g., `{"custom_filed_name1": "custom_field_value1","custom_filed_name2": "custom_field_value2"}`)

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-custom-fields' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'custom_fields={"customer_name":"John Doe","customer_email":"john@example.com"}'

Sample Response:

{"status":"1","message":"Subscriber changes have been saved successfully."}

قائمة Custom Fields

استرجع جميع custom fields المُعدّة في حسابك.

Endpoint: POST /api/v1/whatsapp/subscriber/custom-fields/list

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/custom-fields/list

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/custom-fields/list' \
  -d 'apiToken=API-KEY'

Sample Response:

{
  "status":"1",
  "message":"Custom fields retrieved successfully",
  "data":[
    {
      "id":1,
      "name":"customer_name",
      "reply_type":"text"
    },
    {
      "id":2,
      "name":"customer_email",
      "reply_type":"email"
    }
  ]
}

تعيين Labels

أضف labels إلى subscriber.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/assign-labels

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-labels

Assign Labels endpoint in the API console showing parameters and sample response

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number
`label_ids`	String	Yes	Label IDs, comma-separated (e.g., `1,4,5`)

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-labels' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'label_ids=1,4,5'

Sample Response:

{"status":"1","message":"Labels have been assigned successfully."}

إزالة Labels

أزل labels من subscriber.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/remove-labels

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-labels

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number
`label_ids`	String	Yes	Label IDs to remove, comma-separated

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-labels' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'label_ids=1,4,5'

Sample Response:

{"status":"1","message":"Labels have been assigned successfully."}

تعيين تسلسل

أضف subscriber إلى حملة تسلسل (سلسلة رسائل آلية).

Endpoint: POST /api/v1/whatsapp/subscriber/chat/assign-sequence

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-sequence

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number
`sequence_ids`	String	Yes	Sequence IDs, comma-separated (e.g., `1,4,5`)

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/assign-sequence' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'sequence_ids=1,4,5'

Sample Response:

{"status":"1","message":"Sequences have been assigned successfully."}

إزالة تسلسل

أزل subscriber من حملة تسلسل.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/remove-sequence

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-sequence

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number
`sequence_ids`	String	Yes	Sequence IDs to remove, comma-separated

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/remove-sequence' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'sequence_ids=1,4,5'

Sample Response:

{"status":"1","message":"Sequences have been removed successfully."}

إضافة ملاحظات إلى Subscriber

أضف ملاحظة إلى ملف subscriber للرجوع إليها داخلياً.

Endpoint: POST /api/v1/whatsapp/subscriber/chat/add-notes

Full URL: https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/add-notes

Parameters:

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID
`phone_number`	String	Yes	Subscriber's phone number
`note_text`	String	Yes	The note text to add

POST Request (curl):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/subscriber/chat/add-notes' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'note_text=Customer requested follow-up next week'

Sample Response:

{"status":"1","message":"Notes have been added successfully."}

واجهة برمجة تطبيقات إدارة Subscriber في WhatChimp

الحصول على Subscriber

عرض قائمة Subscribers

إنشاء Subscriber

تحديث Subscriber

حذف Subscriber

عمليات Subscriber المتقدمة

إعادة تعيين User Input Flow

تعيين المحادثة لعضو فريق

تعيين Custom Fields

قائمة Custom Fields

تعيين Labels

إزالة Labels

تعيين تسلسل

إزالة تسلسل

إضافة ملاحظات إلى Subscriber

مقالات ذات صلة

More in WhatChimp APIs