グラフAPIバージョン

Page Messenger Lead Forms

読み取り

Read all messenger_lead_forms owned by the page

Graph API Explorer
GET /v21.0/{page-id}/messenger_lead_forms HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{page-id}/messenger_lead_forms',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/messenger_lead_forms",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/messenger_lead_forms",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/messenger_lead_forms"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
グラフAPIを使用する方法については、グラフAPIの使用ガイドをご覧ください。

パラメーター

このエンドポイントにはパラメーターがありません。

項目

このエッジからの読み込むではJSONフォーマットの結果が返されます:

{ "data": [], "paging": {} }

data

MessengerAdsPartialAutomatedStepListノードの一覧です。

paging

ページネ―ションについて詳しくは、グラフAPIガイドをご覧ください。

エラーコード

エラー詳細
200Permissions error
283That action requires the extended permission pages_read_engagement and/or pages_read_user_content and/or pages_manage_ads and/or pages_manage_metadata
100Invalid parameter
210User not visible
190Invalid OAuth 2.0 Access Token

作成

messenger_lead_formsのエッジにPOSTリクエストを以下のパスで送信できます:
このエッジにPOSTする場合、a Pageが作成されます。

パラメーター

パラメーター説明
account_id
int64

ID of the account

block_send_api
boolean

Whether to block messages sent using Send API while user is in Lead Gen Experience

handover_app_id
int64

Hand over thread to specified app after leadgen is complete

handover_summary
boolean

Opt-in to get a summary message sent to the target HOP app at the end of the automated flow

privacy_url
URI

Privacy URL for Messenger Lead Gen Experience

reminder_text
string

Reminder text that will be sent to user after inactivity

step_list
array<JSON object>

List of steps in Messenger Lead Gen Experience

必須
step_id
int64

step_id

必須
message
string

message

必須
step_type
enum {QUESTION, CONFIRMATION, DISCLAIMER, DISQUALIFY, INFO, INTRO, SUMMARY, POST_LEAD_TRANSITION}

step_type

必須
reply_type
enum {QUICK_REPLIES, BUTTON_XMA, TEXT, NONE, PREFILL, ICE_BREAKERS, APPOINTMENT, SUBSCRIBE, CALL_PREFERENCE, CONDITIONAL_ANSWER}

reply_type

必須
answers
array<string>
デフォルト値: []

answers

next_step_ids
array<int64>
デフォルト値: []

next_step_ids

prefill_type
enum {FULL_ADDRESS, STREET_ADDRESS, ZIP_CODE, POST_CODE, CITY, STATE, PROVINCE, COUNTRY, EMAIL, PHONE, JOB_TITLE, COMPANY_NAME, GENDER, DOB, DATE_TIME, SLIDER, NONE, FIRST_NAME, LAST_NAME, FULL_NAME, RELATIONSHIP_STATUS, MARITAL_STATUS, MILITARY_STATUS, WORK_EMAIL, WORK_PHONE, NATIONAL_ID_BRAZIL, NATIONAL_ID_ARGENTINA, NATIONAL_ID_PERU, NATIONAL_ID_CHILE, NATIONAL_ID_COLOMBIA, NATIONAL_ID_ECUADOR, NATIONAL_ID_MEXICO}
デフォルト値: "NONE"

prefill_type

crm_field_id
string

crm_field_id

answer_crm_field_ids
array<string>
デフォルト値: []

answer_crm_field_ids

media_type
enum {TEXT, IMAGE, VIDEO}

media_type

media_content
string

media_content

options_format
enum {TEXT, CAROUSEL}
デフォルト値: "TEXT"

options_format

carousel_answers
array<JSON object>
デフォルト値: []

carousel_answers

value
string

value

必須
media_content
string

media_content

必須
answer_validation_enabled
boolean

answer_validation_enabled

invalid_reply_text
string

invalid_reply_text

cta
JSON object

cta

cta_type
enum {VIEW_WEBSITE, CALL_BUSINESS, MESSAGE_BUSINESS, DOWNLOAD, SCHEDULE_APPOINTMENT, VIEW_ON_FACEBOOK, PROMO_CODE, NONE, WHATSAPP, P2B_MESSENGER}

cta_type

必須
cta_text
string

cta_text

必須
cta_content
string

cta_content

必須
allow_to_skip
boolean

allow_to_skip

qualifying_answers_list
array<string>

qualifying_answers_list

next_step_on_disqualification_id
int64

next_step_on_disqualification_id

offer_code_file_id
int64

offer_code_file_id

offer_code
string

offer_code

offer_code_format
string

offer_code_format

stop_question_message
string

Confirmation message after user clicks on the Stop Question option in persistent menu

template_name
string

Name for the form

tracking_parameters
JSON object {string : string}

Tracking Parameters of Lead Forms

戻り値の型

このエンドポイントはリード‐アフター‐ライトに対応し、idによって表されたノードを戻り値の型で読み込みます。
Struct {
id: numeric string,
}

エラーコード

エラー詳細
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed

更新中…

このエンドポイントではこの操作を実行できません。

削除中です

このエンドポイントではこの操作を実行できません。