---
updatedAt: 2026-09-10T02:43:37.000Z
agentTools:
  projectIndex: https://partner-docs.gupshup.io/llms.txt
---

# Request Contact Info

Within an active session window the button can only be sent as an interactive message of type request_contact_info.

# Sample Request:

```curl
curl --location 'https://partner.gupshup.io/partner/app/{appId}/v3/message' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'content-type: application/json' \
--data '{
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    
    "recipient": "{recipientId}",
    "type": "interactive",
    "interactive": {
        "type": "request_contact_info",
        "body": {
            "text": "Please share your phone number so we can reach you."
        },
        "action": {
            "name": "request_contact_info"
        }
    }
}'
```

<br />

# Sample Response:

```curl
{
    "messages": [
        {
            "id": "6c786aad-b4e1-4351-92f6-bd4f1e832783"
        }
    ],
    "messaging_product": "whatsapp",
    "contacts": [
        {
            "input": "{recipientId}",
            "user_id": "{recipientId}"
        }
    ]
}
```

<br />

<br />

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Partner Portal — Interactive REQUEST_CONTACT_INFO Message",
    "description": "Sends a `request_contact_info` interactive message inside the 24-hour customer service window,\nover the WhatsApp Cloud API passthrough route.\n\n`POST https://partner.gupshup.io/partner/app/{appId}/v3/message`\n\n**Why this route.** The form route (`/app/{appId}/msg`) has no field for a nested `interactive`\nobject, so it cannot carry this message. Partner Portal forwards this body byte-for-byte to\nMeta (`PartnerAppRoutesImpl` → `WhatsappApiService`), doing no field mapping — an unknown key\nis carried through and ignored by Meta rather than rejected by Partner Portal.\n\n**Session window.** Only valid inside the 24-hour window. Outside it, the template route\n(`/app/{appId}/template/msg`) with an approved `REQUEST_CONTACT_INFO` template is the only\noption.\n\n**Addressing.** Use `to` for a phone number and `recipient` for a BSUID — they are different\nfields, and the curl this spec is built from uses `recipient`. Because the body is passed\nthrough unmapped, an MSISDN placed in `recipient` is accepted and then produces a message with\nno addressee: `status: failed`, `code: 100`, empty `recipient_id`.\n\n**Both names must match.** `interactive.type` and `interactive.action.name` must each be\n`request_contact_info`; a mismatch is a `400`. `interactive.body.text` is required.\n\n**Response.** This route is not wrapped in `V3Response` — it returns the raw Cloud API JSON.\n",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://partner.gupshup.io/partner",
      "description": "Production"
    }
  ],
  "security": [
    {
      "appApiKey": []
    }
  ],
  "tags": [
    {
      "name": "Messaging",
      "description": "Outbound messaging for a partner app"
    }
  ],
  "paths": {
    "/app/{appId}/v3/message": {
      "post": {
        "tags": [
          "Messaging"
        ],
        "summary": "Request Contact Info",
        "description": "Within an active session window the button can only be sent as an interactive message of type request_contact_info.",
        "operationId": "sendRequestContactInfoInteractiveMessage",
        "parameters": [
          {
            "name": "appId",
            "in": "path",
            "required": true,
            "description": "Partner app id (UUID).",
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "03815d0b-4cce-456b-9150-f3a6936f30ec"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InteractiveRequestContactInfoMessage"
              },
              "examples": {
                "bsuidAddressing": {
                  "summary": "Addressed by BSUID via recipient",
                  "value": {
                    "messaging_product": "whatsapp",
                    "recipient_type": "individual",
                    "recipient": "IN.3724117084395812",
                    "type": "interactive",
                    "interactive": {
                      "type": "request_contact_info",
                      "body": {
                        "text": "Please share your phone number so we can reach you."
                      },
                      "action": {
                        "name": "request_contact_info"
                      }
                    }
                  }
                },
                "phoneAddressing": {
                  "summary": "Addressed by phone number via to",
                  "value": {
                    "messaging_product": "whatsapp",
                    "recipient_type": "individual",
                    "to": "917506080480",
                    "type": "interactive",
                    "interactive": {
                      "type": "request_contact_info",
                      "body": {
                        "text": "Please share your phone number so we can reach you."
                      },
                      "action": {
                        "name": "request_contact_info"
                      }
                    }
                  }
                },
                "withHeaderAndFooter": {
                  "summary": "With optional header and footer",
                  "value": {
                    "messaging_product": "whatsapp",
                    "recipient_type": "individual",
                    "to": "917506080480",
                    "type": "interactive",
                    "interactive": {
                      "type": "request_contact_info",
                      "header": {
                        "type": "text",
                        "text": "Delivery update"
                      },
                      "body": {
                        "text": "Please share your phone number so we can reach you."
                      },
                      "footer": {
                        "text": "Powered by Gupshup"
                      },
                      "action": {
                        "name": "request_contact_info"
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Accepted by Meta. Raw Cloud API JSON, not wrapped in `V3Response`. Delivery is\nconfirmed later on the status webhook, keyed by `messages[0].id`.\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CloudApiSendResponse"
                },
                "examples": {
                  "accepted": {
                    "summary": "Message accepted by Meta",
                    "value": {
                      "messaging_product": "whatsapp",
                      "contacts": [
                        {
                          "input": "IN.3724117084395812",
                          "wa_id": "917506080480"
                        }
                      ],
                      "messages": [
                        {
                          "id": "wamid.HBgMOTE3NTA2MDgwNDgwFQIAERgSN0EyRjJDN0E5NkQxQzRBMkI3AA=="
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Rejected by Meta. Common causes: `interactive.type` and `action.name` disagree,\n`interactive.body.text` missing, or the recipient is outside the 24-hour session window\n(`131047`).\n",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MetaErrorResponse"
                },
                "examples": {
                  "nameMismatch": {
                    "summary": "action.name does not match interactive.type",
                    "value": {
                      "error": {
                        "message": "Invalid parameter",
                        "type": "OAuthException",
                        "code": 100,
                        "is_transient": false,
                        "error_user_title": "Invalid interactive action",
                        "error_user_msg": "Both interactive.type and interactive.action.name must be \"request_contact_info\".",
                        "fbtrace_id": "AUQV0thr2ag2oATWnJ2ctCd"
                      }
                    }
                  },
                  "outsideSessionWindow": {
                    "summary": "No active session with the recipient",
                    "value": {
                      "error": {
                        "message": "Message failed to send because more than 24 hours have passed since the customer last replied to this number",
                        "type": "OAuthException",
                        "code": 131047,
                        "is_transient": false,
                        "fbtrace_id": "AUQV0thr2ag2oATWnJ2ctCd"
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized — missing or invalid app API key.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden — the key has no permission on this app.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "App not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "x-internal": false
      }
    }
  },
  "components": {
    "securitySchemes": {
      "appApiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "App-scoped API key, sent raw (no `Bearer` prefix). Example: `sk_e07dd7c06a7d42bcb743e1bb9bb656fc`"
      }
    },
    "schemas": {
      "InteractiveRequestContactInfoMessage": {
        "type": "object",
        "description": "Cloud API interactive message body. Forwarded to Meta byte-for-byte, so unlisted keys are\ncarried through and ignored rather than rejected.\n",
        "required": [
          "messaging_product",
          "type",
          "interactive"
        ],
        "properties": {
          "messaging_product": {
            "type": "string",
            "description": "Always `whatsapp`.",
            "enum": [
              "whatsapp"
            ],
            "example": "whatsapp"
          },
          "recipient_type": {
            "type": "string",
            "description": "Recipient addressing mode.",
            "enum": [
              "individual"
            ],
            "default": "individual",
            "example": "individual"
          },
          "to": {
            "type": "string",
            "description": "Recipient phone in E.164 without `+`. Use this **or** `recipient`, not both. A BSUID\nplaced here is not resolved.\n",
            "example": "917506080480"
          },
          "recipient": {
            "type": "string",
            "description": "Recipient BSUID, for WABAs enabled for BSUID addressing. Use this **or** `to`. An\nMSISDN placed here leaves the message with no addressee — accepted, then `code: 100`\nwith an empty `recipient_id`.\n",
            "example": "IN.3724117084395812"
          },
          "type": {
            "type": "string",
            "description": "Message type. Always `interactive` for this flow.",
            "enum": [
              "interactive"
            ],
            "example": "interactive"
          },
          "interactive": {
            "$ref": "#/components/schemas/InteractivePayload"
          }
        }
      },
      "InteractivePayload": {
        "type": "object",
        "description": "The interactive object. `header` and `footer` are optional; `body` and `action` are not.",
        "required": [
          "type",
          "body",
          "action"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "Must be `request_contact_info`, and must agree with `action.name`.",
            "enum": [
              "request_contact_info"
            ],
            "example": "request_contact_info"
          },
          "header": {
            "type": "object",
            "description": "Optional header shown above the body.",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "text"
                ],
                "example": "text"
              },
              "text": {
                "type": "string",
                "example": "Delivery update"
              }
            }
          },
          "body": {
            "type": "object",
            "description": "Required. The prompt shown to the customer.",
            "required": [
              "text"
            ],
            "properties": {
              "text": {
                "type": "string",
                "description": "Prompt text. Required — omitting it is a `400`.",
                "example": "Please share your phone number so we can reach you."
              }
            }
          },
          "footer": {
            "type": "object",
            "description": "Optional footer shown below the body.",
            "properties": {
              "text": {
                "type": "string",
                "example": "Powered by Gupshup"
              }
            }
          },
          "action": {
            "type": "object",
            "description": "Required. Names the interaction.",
            "required": [
              "name"
            ],
            "properties": {
              "name": {
                "type": "string",
                "description": "Must be `request_contact_info`, matching `interactive.type`.",
                "enum": [
                  "request_contact_info"
                ],
                "example": "request_contact_info"
              }
            }
          }
        }
      },
      "CloudApiSendResponse": {
        "type": "object",
        "description": "Raw WhatsApp Cloud API send acknowledgement, returned unwrapped. Acceptance only —\ndelivery is reported on the status webhook.\n",
        "properties": {
          "messaging_product": {
            "type": "string",
            "example": "whatsapp"
          },
          "contacts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "input": {
                  "type": "string",
                  "description": "The addressee as supplied in `to` or `recipient`.",
                  "example": "IN.3724117084395812"
                },
                "wa_id": {
                  "type": "string",
                  "description": "Resolved WhatsApp id. Empty when the addressee could not be resolved.",
                  "example": "917506080480"
                }
              }
            }
          },
          "messages": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Meta message id (`wamid.…`). Correlates with the status webhook.",
                  "example": "wamid.HBgMOTE3NTA2MDgwNDgwFQIAERgSN0EyRjJDN0E5NkQxQzRBMkI3AA=="
                }
              }
            }
          }
        }
      },
      "MetaErrorResponse": {
        "type": "object",
        "description": "Meta Graph API error, passed through unchanged.",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "example": "Invalid parameter"
              },
              "type": {
                "type": "string",
                "example": "OAuthException"
              },
              "code": {
                "type": "integer",
                "example": 100
              },
              "error_subcode": {
                "type": "integer"
              },
              "is_transient": {
                "type": "boolean",
                "example": false
              },
              "error_user_title": {
                "type": "string",
                "example": "Invalid interactive action"
              },
              "error_user_msg": {
                "type": "string",
                "example": "Both interactive.type and interactive.action.name must be \"request_contact_info\"."
              },
              "fbtrace_id": {
                "type": "string",
                "example": "AUQV0thr2ag2oATWnJ2ctCd"
              }
            }
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "example": "error"
          },
          "message": {
            "type": "string",
            "example": "Invalid request"
          }
        }
      }
    }
  }
}
```