POST /api/v2/users/{id}/screenpop
Initiates screen pop for user device. Requires the "screen_pop" scope.
Requires scope: screen_pop
Rate limit: 5 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | Yes |
The user's id. ('me' can be used if you are using a user level API key) |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
screen_pop_uri |
String | Yes |
The screen pop's url. Most Url should start with scheme name such as http or https. Be aware that url with userinfo subcomponent, such as "https://username:password@www.example.com" is not supported for security reasons. Launching native apps is also supported through a format such as "customuri://domain.com" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.