GuidesAPI Reference

Ask location

Ask interlocutor to share its location.

When interlocutor accepts, its location attribute will be set.

Available on :

  • facebook
AttributeTypeRequiredDescription
typestring✓always ask_location_action
messagestring✓message sent to ask interlocutor for its location (length<=500)
actionobject<go_to_action>✓a go to action, executed when the interlocutor accepted the geolocation request
{
    "type": "ask_location_action",
    "message": "Where are you?",
    "action": {
        "type": "go_to_action",
        "target": {
            "type": "step",
            "id": "507f191e810c19729de860ea"
        }
    }
}