Skip to main content

Send Message By Payload Id

Version: 1.0

Context​

This API will help you send messages to users via payload id (which you can get from setup Flow in Harasocial).

Authenticated access scopes: social.conv

Requirements​

  1. Must create & publish a Flow and get Flow's Payload Id and pass it to the api.
  2. Must send message inside 24 hours message window. (https://developers.facebook.com/docs/messenger-platform/policy/policy-overview/#contents)

Steps to get Flow's payload id:​

  1. Go to Harasocial: https://app.harasocial.com/ and access the menu Chat Assistant on the left side. flow-payload-id

  2. On menu Chat Assistant, click sub menu Content. flow-payload-id

  3. Click Create new Flow on the top right area. flow-payload-id

  4. Enter Flow name in the popup and click Create. flow-payload-id

  5. Setup your Flow. After done setup, click Publish. flow-payload-id

  6. After Publish success, it will be redirected to Flow's detail page. Then click Share Payload on the top right area. flow-payload-id

  7. The popup Share Payload will appear. The Payload Id looks like this: _hrf_f_.... Click Copy then Save. flow-payload-id

  8. Use copied Payload Id above to call API below. The PSID received a message by this api will go through the Flow linked with the Payload Id.

Request URI​

  • POST https://apis.harasocial.com/social/messages.json

Example Request​

curl -X 'POST' \
  'https://apis.harasocial.com/social/messages.json' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "messaging_type": "harasocial_facebook_payload_id",
  "recipient": {
    "id": "6096577723741858"
  },
  "message": {
    "payload_id": "__hrf_f_63072efd8d1cc15d16c3848e_s_4d12c525111725943cdbf556bd57687d"
  },
  "page_id": "111494948537595",
  "metadata": "Custom string that is delivered as a message echo"
}'

Parameters​

messaging_type: string

"messaging_type": "harasocial_facebook_payload_id"

The messaging type of the message being sent. Payload Id message type is define by value harasocial_facebook_payload_id

recipient: Recipient Object

"recipient": {
  "id": "6096577723741858"
}

Recipient who received message. See Recipient Object.

page_id: string

"page_id": "111494948537595"

Page Id of the page will send this message

metadata: string

"metadata": "Custom string that is delivered as a message echo"

Optional. Custom string that is delivered as a message echo. 500 character limit.

message: Payload Id Object

"message": {
  "payload_id": "__hrf_f_63072efd8d1cc15d16c3848e_s_4d12c525111725943cdbf556bd57687d"
}

Message Payload. See Payload Id Object.

Recipient Object​

id: string

"id": "6096577723741858"

The id that's used as a unique identifier for the participant.

Payload Id Object​

payload_id: string

"payload_id": "__hrf_f_63072efd8d1cc15d16c3848e_s_4d12c525111725943cdbf556bd57687d"

Id of a payload which get from setup content in Harasocial

Response​

A successful Send Messages API request returns a JSON string containing status indicates that the request was passed validation and the system will process it.

Example​

{
  "data": {
    "success": true
  },
  "has_error": false,
  "error_code": null,
  "error_message": null
}

Properties​

data: Success Object

"data": {
  "success": true
}

The result of the action. See Success Object below.

has_error: bool

True if the request does not meet requirement or validation

error_code: string

The error code information

error_message: string

The error message information

Success Object​

success: bool

"success": true

Status indicates that the request was passed validation and the system will process it