Send Location message

This endpoint sends a location message to a phone number on whatsapp.

Please note: We can only send a location message if client has initiated the conversation.

URL:

Method: POST

Parameters:

Parameter

Description

Data Type

Required

recipient_whatsapp

Recipient’s phone number. Must be a valid number. Phone number must include a country code otherwise message might not get delivered.

String

Yes

recipient_type

Indicate whether the recipient is an individualor a group.

Specifying recipient_type in the request is optional when the value is individual. However, recipient_type is required when using group.

String

message_type

Type of a message as location

String

Yes

source

Source id of the origin. Source id must be valid and obtained from source creation API.

String

Yes

longitude

Longitude of the location.It should be valid longitude.

double

Yes

latitude

Latitude of the location.It should be valid latitude.

double

Yes

name

Name of the location.

string

address

Full address of the location.

string

x-apiheader

Any custom data which user needs to send. X-apiheader can be used instead of message id for mapping messages.

String

Request Body

{ 
   "message": [ 
       { 
           "recipient_whatsapp": "919930609609",
           "recipient_type": "individual", 
           "message_type": "location", 
           "source": "329f-998", 
           "x-apiheader": "custom_data", 
           "type_location": [ 
               { 
                   "longitude": -122.425332, 
                   "latitude": 37.758056, 
                   "name": "Facebook HQ", 
                   "address": "1 Hacker Way, Menlo Park, CA 94025" 
               } 
           ] 
       } 
   ] 
}

Responses for message API

In case of success

{ 
   "status": "success", 
   "message": "Request received successfully.", 
   "data": { 
       "id": "6929d4af-490d-454a-8cf3-0502a3506f09" 
   } 
}

This id in response is message id for future response. All the message status updates on webhook will be mapped to this id. So store this message id at your side.

In case of failure

{ 
   "status": "failure", 
   "error": { 
       "code": "8006", 
       "message": " type is required." 
   } 
}

According to error code and message will change.

PreviousSend Media message using URL NextTemplate Message API

Last updated 4 years ago

Was this helpful?

{ "message": [ { "recipient_whatsapp": "919930609609", "recipient_type": "individual", "message_type": "location", "source": "329f-998", "x-apiheader": "custom_data", "type_location": [ { "longitude": -122.425332, "latitude": 37.758056, "name": "Facebook HQ", "address": "1 Hacker Way, Menlo Park, CA 94025" } ] } ] }