ASTERISK-29236: ari: dial route does not use originator in Dial event for caller

[Home]

Summary: ASTERISK-29236: ari: dial route does not use originator in Dial event for caller

Reporter: Kon Tsaki (kontsaki) Labels:

Date Opened: 2021-01-07 14:47:00.000-0600 Date Closed:

Priority: Minor Regression?

Status: Open/New Components: Core/Channels Core/Stasis

Versions: 16.15.0 Frequency of
Occurrence Constant

Related
Issues:

Environment: Linux 4.19.0-13-amd64 Debian buster/testing/sid Attachments: ( 0) ari.log

Description: The ARI Dial event is missing the documented optional field `caller` even though i set the channel id of the caller on the call to `/channels/id/dial` ARI endpoint.

Also it seems that the channel object in the `peer` field has the `caller` and `connected` fields reversed.

Below are the structured json logs of all the flow. I also include the requests/responses i do to ARI between events as a json as well.

I used two softphones, 7000 is calling 6000.

Events for ChannelVarset are ommited.

{noformat}
{
"event": {
"type": "StasisStart",
"timestamp": "2021-01-07T20:25:29.735+0000",
"args": [],
"channel": {
"id": "1610051129.9",
"name": "SIP/7000-00000006",
"state": "Ring",
"caller": {
"name": "Name 7000",
"number": "7000"
},
"connected": {
"name": "",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "6000",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.734+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"request": {
"method": "GET",
"url": "/endpoints/sip/6000"
},
"response": {
"status": 200,
"technology": "SIP",
"resource": "6000",
"state": "online",
"channel_ids": [
"1610049591.7"
]
}
}
}
{
"event": {
"request": {
"method": "POST",
"url": "/channels/1610051129.9/ring"
},
"response": {
"status": 204
}
}
}
{
"event": {
"request": {
"method": "POST",
"url": "/channels/create",
"json": {
"endpoint": "SIP/6000",
"app": "my-app"
}
},
"response": {
"status": 200,
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Down",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "",
"app_data": ""
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
}
}
}
{
"event": {
"type": "ChannelDialplan",
"timestamp": "2021-01-07T20:25:29.776+0000",
"dialplan_app": "Stasis",
"dialplan_app_data": "my-app",
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Down",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "StasisStart",
"timestamp": "2021-01-07T20:25:29.776+0000",
"args": [],
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Down",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"request": {
"method": "POST",
"url": "/bridges"
},
"response": {
"status": 200,
"id": "7c6eb0b1-bd69-4f33-8e6e-b8044c2e4095",
"technology": "simple_bridge",
"bridge_type": "mixing",
"bridge_class": "stasis",
"creator": "Stasis",
"name": "",
"channels": [],
"creationtime": "2021-01-07T20:25:29.780+0000",
"video_mode": "talker"
}
}
}
{
"event": {
"type": "ChannelEnteredBridge",
"timestamp": "2021-01-07T20:25:29.977+0000",
"bridge": {
"id": "7c6eb0b1-bd69-4f33-8e6e-b8044c2e4095",
"technology": "simple_bridge",
"bridge_type": "mixing",
"bridge_class": "stasis",
"creator": "Stasis",
"name": "",
"channels": [
"1610051129.10"
],
"creationtime": "2021-01-07T20:25:29.780+0000",
"video_mode": "talker"
},
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Down",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "ChannelEnteredBridge",
"timestamp": "2021-01-07T20:25:30.137+0000",
"bridge": {
"id": "7c6eb0b1-bd69-4f33-8e6e-b8044c2e4095",
"technology": "simple_bridge",
"bridge_type": "mixing",
"bridge_class": "stasis",
"creator": "Stasis",
"name": "",
"channels": [
"1610051129.10",
"1610051129.9"
],
"creationtime": "2021-01-07T20:25:29.780+0000",
"video_mode": "talker"
},
"channel": {
"id": "1610051129.9",
"name": "SIP/7000-00000006",
"state": "Ring",
"caller": {
"name": "Name 7000",
"number": "7000"
},
"connected": {
"name": "",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "6000",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.734+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"request": {
"method": "POST",
"url": "/bridges/7c6eb0b1-bd69-4f33-8e6e-b8044c2e4095/addChannel",
"json": {
"channel": [
"1610051129.10",
"1610051129.9"
],
"role": null,
"absorbDTMF": null,
"mute": null
}
},
"response": {
"status": 204
}
}
}
{
"event": {
"type": "ChannelConnectedLine",
"timestamp": "2021-01-07T20:25:30.137+0000",
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Down",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "ChannelConnectedLine",
"timestamp": "2021-01-07T20:25:30.137+0000",
"channel": {
"id": "1610051129.9",
"name": "SIP/7000-00000006",
"state": "Ring",
"caller": {
"name": "Name 7000",
"number": "7000"
},
"connected": {
"name": "Name 6000",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "6000",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.734+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"request": {
"method": "POST",
"url": "/channels/1610051129.10/dial",
"json": {
"caller": "1610051129.9",
"timeout": null
}
},
"response": {
"status": 204
}
}
}
{
"event": {
"type": "Dial",
"timestamp": "2021-01-07T20:25:30.145+0000",
"dialstatus": "",
"forward": "",
"dialstring": "6000",
"peer": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Down",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "ChannelStateChange",
"timestamp": "2021-01-07T20:25:30.238+0000",
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Ringing",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "Dial",
"timestamp": "2021-01-07T20:25:30.239+0000",
"dialstatus": "RINGING",
"forward": "",
"dialstring": "",
"peer": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Ringing",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "ChannelStateChange",
"timestamp": "2021-01-07T20:25:33.619+0000",
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Up",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "Dial",
"timestamp": "2021-01-07T20:25:33.620+0000",
"dialstatus": "ANSWER",
"forward": "",
"dialstring": "",
"peer": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Up",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "ChannelStateChange",
"timestamp": "2021-01-07T20:25:33.620+0000",
"channel": {
"id": "1610051129.9",
"name": "SIP/7000-00000006",
"state": "Up",
"caller": {
"name": "Name 7000",
"number": "7000"
},
"connected": {
"name": "Name 6000",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "6000",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.734+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"cause": 16,
"type": "ChannelHangupRequest",
"timestamp": "2021-01-07T20:25:35.469+0000",
"channel": {
"id": "1610051129.9",
"name": "SIP/7000-00000006",
"state": "Up",
"caller": {
"name": "Name 7000",
"number": "7000"
},
"connected": {
"name": "Name 6000",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "6000",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.734+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "ChannelLeftBridge",
"timestamp": "2021-01-07T20:25:35.470+0000",
"bridge": {
"id": "7c6eb0b1-bd69-4f33-8e6e-b8044c2e4095",
"technology": "native_rtp",
"bridge_type": "mixing",
"bridge_class": "stasis",
"creator": "Stasis",
"name": "",
"channels": [
"1610051129.10"
],
"creationtime": "2021-01-07T20:25:29.780+0000",
"video_mode": "talker"
},
"channel": {
"id": "1610051129.9",
"name": "SIP/7000-00000006",
"state": "Up",
"caller": {
"name": "Name 7000",
"number": "7000"
},
"connected": {
"name": "Name 6000",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "6000",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.734+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "StasisEnd",
"timestamp": "2021-01-07T20:25:35.470+0000",
"channel": {
"id": "1610051129.9",
"name": "SIP/7000-00000006",
"state": "Up",
"caller": {
"name": "Name 7000",
"number": "7000"
},
"connected": {
"name": "Name 6000",
"number": ""
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "6000",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.734+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"cause": 16,
"type": "ChannelHangupRequest",
"timestamp": "2021-01-07T20:25:36.511+0000",
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Up",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "ChannelLeftBridge",
"timestamp": "2021-01-07T20:25:36.512+0000",
"bridge": {
"id": "7c6eb0b1-bd69-4f33-8e6e-b8044c2e4095",
"technology": "simple_bridge",
"bridge_type": "mixing",
"bridge_class": "stasis",
"creator": "Stasis",
"name": "",
"channels": [],
"creationtime": "2021-01-07T20:25:29.780+0000",
"video_mode": "talker"
},
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Up",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "StasisEnd",
"timestamp": "2021-01-07T20:25:36.512+0000",
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Up",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{
"event": {
"type": "ChannelDestroyed",
"timestamp": "2021-01-07T20:25:36.515+0000",
"cause": 16,
"cause_txt": "Normal Clearing",
"channel": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Up",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "",
"app_data": ""
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
}
{noformat}

Comments: By: Asterisk Team (asteriskteam) 2021-01-07 14:47:02.941-0600

Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution. Please note that log messages and other files should not be sent to the Sangoma Asterisk Team unless explicitly asked for. All files should be placed on this issue in a sanitized fashion as needed.

A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report.

Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process].

Please note that once your issue enters an open state it has been accepted. As Asterisk is an open source project there is no guarantee or timeframe on when your issue will be looked into. If you need expedient resolution you will need to find and pay a suitable developer. Asking for an update on your issue will not yield any progress on it and will not result in a response. All updates are posted to the issue when they occur.

Please note that by submitting data, code, or documentation to Sangoma through JIRA, you accept the Terms of Use present at [https://www.asterisk.org/terms-of-use/|https://www.asterisk.org/terms-of-use/].
By: Kon Tsaki (kontsaki) 2021-01-07 14:48:21.313-0600

the logs as an attachment
By: Kon Tsaki (kontsaki) 2021-01-08 03:48:13.567-0600

what i've tried so far:

* tried the request to `/channels/id/dial` with both a json body and url params

* adding the `originator` field on the channel object on channel creation

* tried with both originate and simple channel creation

* adding the following log message

{noformat}
--- a/main/stasis_channels.c
+++ b/main/stasis_channels.c
@@ -352,7 +352,7 @@
if (!payload) {
return;
}
-
+ ast_log(LOG_ERROR, "caller: %p\n", caller);
if (caller) {
struct ast_channel_snapshot *caller_snapshot;
{noformat}

prints:
{noformat}
ERROR[937]: stasis_channels.c:355 ast_channel_publish_dial_internal: caller: (nil)
{noformat}

By: Benjamin Keith Ford (bford) 2021-01-12 15:48:43.650-0600

Can you provide the commands you are using and what documentation you're looking at? There may be a discrepancy in the code compared to the documentation. I'll take a look at what the code is expecting.
By: Kon Tsaki (kontsaki) 2021-01-13 00:57:27.752-0600

hello, i am using the `dial` command on the channel as described in the [documentation here|https://wiki.asterisk.org/wiki/display/AST/Asterisk+16+Channels+REST+API#Asterisk16ChannelsRESTAPI-dial] and as it appears on the log i provided

{noformat}
{
"request": {
"method": "POST",
"url": "/channels/1610051129.10/dial",
"json": {
"caller": "1610051129.9",
"timeout": null
}
},
"response": {
"status": 204
}
}
{noformat}

i am setting the channel id of the caller field of the dial command as it's described in the documentation
{quote}
caller: string - Channel ID of caller
{quote}

In the Dial event [documentation here|https://wiki.asterisk.org/wiki/display/AST/Asterisk+16+REST+Data+Models#Asterisk16RESTDataModels-Dial] there is a `caller` field which is a Channel object but it doesn't exist on the Dial event as you can see on the log

{noformat}
{
"type": "Dial",
"timestamp": "2021-01-07T20:25:33.620+0000",
"dialstatus": "ANSWER",
"forward": "",
"dialstring": "",
"peer": {
"id": "1610051129.10",
"name": "SIP/6000-00000007",
"state": "Up",
"caller": {
"name": "Name 6000",
"number": ""
},
"connected": {
"name": "Name 7000",
"number": "7000"
},
"accountcode": "",
"dialplan": {
"context": "stasis-my-app",
"exten": "",
"priority": 1,
"app_name": "Stasis",
"app_data": "my-app"
},
"creationtime": "2021-01-07T20:25:29.776+0000",
"language": "en"
},
"asterisk_id": "00:16:3e:89:0e:64",
"application": "my-app"
}
{noformat}

i'm expecting the `caller` field on the Dial event as it's described in the documentation
{quote}
caller: Channel (optional) - The calling channel.
{quote}

documentation that i'm using:

channel dial command:
https://wiki.asterisk.org/wiki/display/AST/Asterisk+16+Channels+REST+API#Asterisk16ChannelsRESTAPI-dial

Dial event:
https://wiki.asterisk.org/wiki/display/AST/Asterisk+16+REST+Data+Models#Asterisk16RESTDataModels-Dial
By: Joshua C. Colp (jcolp) 2021-01-18 04:23:32.637-0600

The problem is because of the app_control_dial function in res/stasis/control.c.

It does not preserve/know the originator, and thus does not pass it in when publishing the Dial event.