‏API السحابة‏

رسائل طلب الموقع

تعرض رسائل طلب الموقع نصًا أساسيًا وزر إرسال الموقع. عندما يضغط مستخدم واتساب على الزر، تظهر شاشة مشاركة الموقع والتي يمكن للمستخدم استخدامها بعد ذلك لمشاركة موقعه.


بمجرد مشاركة المستخدم موقعه، يتم تشغيل حدث webhook للرسائل، يحتوي على تفاصيل موقع المستخدم.

إرسال رسائل طلب الموقع

استخدم نقطة النهاية POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages لإرسال رسالة طلب الموقع إلى مستخدم واتساب.

بنية الطلب

POST /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/messages

نص المنشور

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "type": "interactive",
  "to": "<WHATSAPP_USER_PHONE_NUMBER>",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "<BODY_TEXT>"
    },
    "action": {
      "name": "send_location"
    }
  }
}

معلمات نص المنشور

العنصر النائبالوصفمثال على القيمة

<BODY_TEXT>

String (سلسلة)

مطلوب.

نص الرسالة. يتم دعم عناوين URL.

بحد أقصى 1024 حرفًا.

Let's start with your pickup. You can either manually *enter an address* or *share your current location*.

<WHATSAPP_USER_PHONE_NUMBER>

String

Required.

WhatsApp user phone number.

+16505551234

الاستجابة

عند نجاح العملية:

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "<WHATSAPP_USER_PHONE_NUMBER>",
      "wa_id": "<WHATSAPP_USER_ID>"
    }
  ],
  "messages": [
    {
      "id": "<WHATSAPP_MESSAGE_ID>",
      "message_status": "<PACING_STATUS>"
    }
  ]
}

محتوى الاستجابة

PlaceholderDescriptionSample Value

<WHATSAPP_USER_PHONE_NUMBER>

String

WhatsApp user's WhatsApp phone number. May not match wa_id value.

+16505551234

<WHATSAPP_USER_ID>

String

WhatsApp user's WhatsApp ID. May not match input value.

16505551234

<WHATSAPP_MESSAGE_ID>

String

WhatsApp Message ID. This ID appears in associated messages webhooks, such as sent, read, and delivered webhooks.

wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI4MjZGRDA0OUE2OTQ3RkEyMzcA

<PACING_STATUS>

String

Indicates template pacing status. The message_status property is only included in responses when sending a template message that uses a template that is being paced.

wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI4MjZGRDA0OUE2OTQ3RkEyMzcA

Webhook

عندما يشارك مستخدم واتساب موقعه ردًا على رسالتك، يتم تشغيل حدث webhook للرسائل والذي يحتوي على تفاصيل موقع المستخدم.

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "context": {
                  "from": "<WHATSAPP_BUSINESS_PHONE_NUMBER>",
                  "id": "<WHATSAPP_CONTEXT_MESSAGE_ID>"
                },
                "from": "<WHATSAPP_USER_ID>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "location": {
                  "address": "<LOCATION_ADDRESS>",
                  "latitude": <LOCATION_LATITUDE>,
                  "longitude": <LOCATION_LONGITUDE>,
                  "name": "<LOCATION_NAME>"
                },
                "type": "location"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

محتويات حدث Webhook

العنصر النائبالوصفمثال على القيمة

<LOCATION_ADDRESS>

String (سلسلة)

عنوان الموقع.

ستظهر هذه المعلمة فقط إذا اختار مستخدم واتساب مشاركتها.

1071 5th Ave, New York, NY 10128

<LOCATION_LATITUDE>

Number (رقم)

خط عرض الموقع بالدرجات العشرية.

40.782910059774

<LOCATION_LONGITUDE>

Number (رقم)

خط الطول الموقع بالدرجات العشرية.

-73.959075808525

<LOCATION_NAME>

String (سلسلة)

اسم الموقع.

ستظهر هذه المعلمة فقط إذا اختار مستخدم واتساب مشاركتها.

Solomon R. Guggenheim Museum

<TIMESTAMP>

String (سلسلة)

طابع زمني بتنسيق UNIX إلى الوقت الذي قامت فيه خوادمنا بمعالجة رسالة مستخدم واتساب.

1702920965

<WHATSAPP_BUSINESS_ACCOUNT_ID>

String (سلسلة)

معرف حساب واتساب للأعمال.

102290129340398

<WHATSAPP_BUSINESS_DISPLAY_PHONE_NUMBER>

String (سلسلة)

رقم عرض رقم هاتف واتساب للأعمال.

15550783881

<WHATSAPP_BUSINESS_PHONE_NUMBER>

String (سلسلة)

رقم هاتف واتساب للأعمال.

15550783881

<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>

String (سلسلة)

معرف رقم هاتف واتساب للأعمال.

106540352242922

<WHATSAPP_CONTEXT_MESSAGE_ID>

String (سلسلة)

معرف رسالة واتساب للرسالة التي يرد عليها المستخدم.

wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA

<WHATSAPP_MESSAGE_ID>

String (سلسلة)

معرف رسالة واتساب لرسالة المستخدم.

wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTRCRDcwNzgzMTRDNTAwRTgwRQA=

<WHATSAPP_USER_ID>

String (سلسلة)

معرف واتساب لمستخدم واتساب.

16505551234

<WHATSAPP_USER_NAME>

String (سلسلة)

اسم مستخدم واتساب.

Pablo Morales

مثال على الطلب

curl 'https://graph.facebook.com/v21.0/106540352242922/messages' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "type": "interactive",
  "to": "+16505551234",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "Let us start with your pickup. You can either manually *enter an address* or *share your current location*."
    },
    "action": {
      "name": "send_location"
    }
  }
}'

مثال على الاستجابة

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "+16505551234",
      "wa_id": "16505551234"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBJCNUQ5RUNBNTk3OEQ2M0ZEQzgA"
    }
  ]
}

مثال على حدث Webhook

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "102290129340398",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "15550783881",
              "phone_number_id": "106540352242922"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Pablo Morales"
                },
                "wa_id": "16505551234"
              }
            ],
            "messages": [
              {
                "context": {
                  "from": "15550783881",
                  "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgARGBI1QjJGRjI1RDY0RkE4Nzg4QzcA"
                },
                "from": "16505551234",
                "id": "wamid.HBgLMTY0NjcwNDM1OTUVAgASGBQzQTRCRDcwNzgzMTRDNTAwRTgwRQA=",
                "timestamp": "1702920965",
                "location": {
                  "address": "1071 5th Ave, New York, NY 10128",
                  "latitude": 40.782910059774,
                  "longitude": -73.959075808525,
                  "name": "Solomon R. Guggenheim Museum"
                },
                "type": "location"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}