You can use the "Send Location" API in one case only:

  • You reply to a message that the client sent, within 24 hours since the client sent his last message.


If you send a message to a new client, or try to send a message to an old client (old client means that 24 hours since client's last message has passed), you must use the "Send Template Message" API instead.

If you send a template message to the client, and the client did not reply yet, and you want to send another message to him, you must use the template message again.


More Remarks

  • You can only send a location to private people, not groups.
  • The billing is per "conversation". conversation means a 24 hours session between you and the client (this 24 hours conversation session is unrelated to the 24 hours timer for template message)
  • You can send unlimited messages within the 24 hours session time of a conversation.
  • 24 hours session conversation starts when you send a message to the client.


Settings:

URL

https://api.99digital.co.il/whatsapp/v2/sendLocation

Method

JSON via POST



Body:

Parameter

Description / Example

Mandatory

apiKey

Your API key for the service

yes

from

your WhatsApp account. international number without +. for example: 972771234567

yes

to

The number you want to send the message to. for example: 972501234567

yes

lat

latitude of the location. example: "37.422"

yes

lng

longitude of the location. example: "-122.084"

yes

caption

This is the text that will next to the location of to the lat/lng. usually this is for address. example "Big Ben, London"

no

replyTo

In case you want to reply to a message that the end user has sent (quoted message), here you can provide the unique ID of that message

no

showRequest

You can get back in the response an object with all the request you sent (without the 'apiKey')

default is off (0)

1 - enable

no



Response:


{
"status": "OK",
"unique": "65dfd4r4dref34rdfxd34r",
"lat": "37.422",
"lng": "-122.084",
"caption": "Big Ben, London",
"timestamp": 1600115719,
"from": "972507654321",
"to": "972501234567",
"templateTimeLeft": "400",
"reason": 1
}




Response-Explain:

Parameter

Description

status

OK or FAIL

unique

unique ID for any message

lat

the latitude

lng

the longitude

caption

the caption you sent

timestamp

time stamp

from

your WhatsApp account

to

the number that the message was sent to

templateTimeLeft

amount of minutes left since client's last message. if passed, you must use Template Message. This value resets every time the client is sending you a message.

conversationTimeLeft

Deprecated

this value is no longer in use.

Conversation time left is now part of the webhook response instead.

This parameter will be removed in future updates. until then, this value will show 0 always.

originalRequest

Original request object, if you enabled this in 'showRequest' when sending the request.

reason

'reason' is the status explanation in case of FAIL

1

not FAIL. the status is OK

2

Your "from" number account does not exist, or JSON syntax error

3

wrong apiKey

4

 'to' is either empty or wrong number format

6

WhatsApp error - try again

7

You are trying to send a message but it has been more than 24 hours since client's last message. please use Send Template instead

8

You are trying to send a message for first time to a contact. please use Send Template Message instead

9

rate limit error, try again

Created with the Personal Edition of HelpNDoc: Free Web Help generator