This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
To Top
To Bottom
DialNumber
- Type
- Function
- Sender
- SDL
- Purpose
- SDL initiates a call to a specific phone number.
Note
SDL looks to see if the phone number entered is correct before passing to the HMI. The checks performed are:
- Strip any characters except of 0-9 and * # , ;+ and pass resulting number to HMI.
- Return INVALID_DATA to mobile side without transferring "number" to the HMI if "number" is empty after stripping invalid characters.
- Return INVALID_DATA to mobile side without transferring "number" to HMI if the characters "/n" , "/t", or spaces are included in "number".
Must
- Show DialNumber pop-up on HMI with 2 buttons, "Call" and "Cancel".
- Send the notification BC.OnOnPhoneCall(isActive:true) to SDL when the phone call is started on the HMI.
- Send the notification BC.OnOnPhoneCall(isActive:false) to SDL when the phone call is ended on the HMI.
- Always respond to BC.DialNumber with a response code. If the HMI does not respond, the mobile application will never get a response from SDL because default timeouts do not apply to the DialNumber mobile API.
- Send the notification
BC.OnResetTimeoutto SDL for resetting timeout in case HMI needs more time to process theBC.DialNumberrequest.
May
- Send the notification
BC.OnAppDeactivatedto SDL if the HMI leaves the app screen when the phone call is started.
The request is considered to have been executed successfully only after the user presses the "Call" button included in the DialNumber dialog.
Request
Parameters
| Name | Type | Mandatory | Additional |
|---|---|---|---|
| number | String | true | maxlength: 40 |
| appID | Integer | true |
Response
Parameters
This RPC has no additional parameter requirements
Sequence Diagrams
JSON Message Examples
Example Request
{ "id" : 59, "jsonrpc" : "2.0", "method" : "BasicCommunication.DialNumber", "params" : { "number" : "*111#", "appID" : 65537 } }
Example Response
{ "id" : 59, "jsonrpc" : "2.0", "result" : { "code" : 0, "method" : "BasicCommunication.DialNumber" } }
Example Error
{ "id" : 59, "jsonrpc" : "2.0", "error" : { "code" : 5, "message" : " HMI is busy with higher priority RPC ", "data" : { "method" : "BasicCommunication.DialNumber" } } }