Tcl Dynamics CRM: Get Phone Calls Regarding an Account

Back to Index

Returns the subject, description, start date/time and activity ID for phone calls regarding an account. This example gets the phone calls regarding the Fourth Coffee account (accountid = b6a19cdd-88df-e311-b8e5-6c3be5a8b200).

Documentation: https://docs.microsoft.com/en-us/dynamics365/customer-engagement/web-api/phonecall?view=dynamics-ce-odata-9

CURL Command

curl -X GET https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/phonecalls \
  -H "Accept: application/json" \
  -H "OData-MaxVersion: 4.0"  \
  -H "OData-Version: 4.0" \
  -d "$filter=_regardingobjectid_value eq b6a19cdd-88df-e311-b8e5-6c3be5a8b200" \
  -d "$select=subject,description,actualstart,activityid" \
  -H "Authorization: Bearer DYNAMICS_CRM_ACCESS_TOKEN"

Tcl Example

load ./chilkat.dll

set rest [new_CkRest]

#  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/phonecalls
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "my-dynamics-domain.api.crm.dynamics.com" $port $bTls $bAutoReconnect]
if {[expr $success != 1]} then {
    puts "ConnectFailReason: [CkRest_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

CkRest_AddQueryParam $rest "$filter" "_regardingobjectid_value eq b6a19cdd-88df-e311-b8e5-6c3be5a8b200"
CkRest_AddQueryParam $rest "$select" "subject,description,actualstart,activityid"

CkRest_AddHeader $rest "OData-MaxVersion" "4.0"
CkRest_AddHeader $rest "Accept" "application/json"
CkRest_AddHeader $rest "OData-Version" "4.0"
CkRest_AddHeader $rest "Authorization" "Bearer DYNAMICS_CRM_ACCESS_TOKEN"

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/api/data/v9.0/phonecalls" $sbResponseBody]
if {[expr $success != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_ResponseStatusCode $rest]
if {[expr $respStatusCode >= 400]} then {
    puts "Response Status Code = $respStatusCode"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jsonResponse [new_CkJsonObject]

CkJsonObject_LoadSb $jsonResponse $sbResponseBody

set odataContext [CkJsonObject_stringOf $jsonResponse "\"@odata.context\""]
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "value"]
while {[expr $i < $count_i]} {
    CkJsonObject_put_I $jsonResponse $i
    set odataEtag [CkJsonObject_stringOf $jsonResponse "value[i].\"@odata.etag\""]
    set subject [CkJsonObject_stringOf $jsonResponse "value[i].subject"]
    set description [CkJsonObject_stringOf $jsonResponse "value[i].description"]
    set actualstart [CkJsonObject_stringOf $jsonResponse "value[i].actualstart"]
    set activityid [CkJsonObject_stringOf $jsonResponse "value[i].activityid"]
    set i [expr $i + 1]
}

delete_CkRest $rest
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse

Sample JSON Response Body

{
  "@odata.context": "https://mydomain.api.crm.dynamics.com/api/data/v9.0/$metadata#phonecalls(subject,description,actualstart,activityid)",
  "value": [
    {
      "@odata.etag": "W/\"1818469\"",
      "subject": "Discussed coffee bean pricing.",
      "description": "Discussed coffee bean pricing.",
      "actualstart": "2018-04-29T11:56:21Z",
      "activityid": "098af854-a44b-e811-a955-000d3a1ca612"
    }
  ]
}