PowerShell 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"

PowerShell Example

[Reflection.Assembly]::LoadFile("C:\myAssemblies\ChilkatDotNet2.dll")

$rest = New-Object Chilkat.Rest

#  URL: https://my-dynamics-domain.api.crm.dynamics.com/api/data/v9.0/phonecalls
$bTls = $true
$port = 443
$bAutoReconnect = $true
$success = $rest.Connect("my-dynamics-domain.api.crm.dynamics.com",$port,$bTls,$bAutoReconnect)
if ($success -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

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

$rest.AddHeader("OData-MaxVersion","4.0")
$rest.AddHeader("Accept","application/json")
$rest.AddHeader("OData-Version","4.0")
$rest.AddHeader("Authorization","Bearer DYNAMICS_CRM_ACCESS_TOKEN")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("GET","/api/data/v9.0/phonecalls",$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
if ($respStatusCode -ge 400) {
    $("Response Status Code = " + $respStatusCode)
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jsonResponse = New-Object Chilkat.JsonObject
$jsonResponse.LoadSb($sbResponseBody)

$odataContext = $jsonResponse.StringOf("`"@odata.context`"")
$i = 0
$count_i = $jsonResponse.SizeOfArray("value")
while ($i -lt $count_i) {
    $jsonResponse.I = $i
    $odataEtag = $jsonResponse.StringOf("value[i].`"@odata.etag`"")
    $subject = $jsonResponse.StringOf("value[i].subject")
    $description = $jsonResponse.StringOf("value[i].description")
    $actualstart = $jsonResponse.StringOf("value[i].actualstart")
    $activityid = $jsonResponse.StringOf("value[i].activityid")
    $i = $i + 1
}

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"
    }
  ]
}