You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/openapi.yaml
+233Lines changed: 233 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -693,6 +693,185 @@ paths:
693
693
- description: Production
694
694
url: https://messaging.bandwidth.com/api/v2
695
695
/accounts/{accountId}/calls:
696
+
get:
697
+
description: |-
698
+
Returns a max of 10000 calls, sorted by `createdTime` from oldest to newest.
699
+
700
+
**NOTE:** If the number of calls in the account is bigger than `pageSize`, a `Link` header (with format `<{url}>; rel="next"`) will be returned in the response. The url can be used to retrieve the next page of call records.
701
+
Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response.
702
+
operationId: listCalls
703
+
parameters:
704
+
- description: Your Bandwidth Account ID.
705
+
example: "9900000"
706
+
explode: false
707
+
in: path
708
+
name: accountId
709
+
required: true
710
+
schema:
711
+
type: string
712
+
style: simple
713
+
- description: Filter results by the `to` field.
714
+
example: '%2b19195551234'
715
+
explode: true
716
+
in: query
717
+
name: to
718
+
required: false
719
+
schema:
720
+
type: string
721
+
style: form
722
+
- description: Filter results by the `from` field.
723
+
example: '%2b19195554321'
724
+
explode: true
725
+
in: query
726
+
name: from
727
+
required: false
728
+
schema:
729
+
type: string
730
+
style: form
731
+
- description: Filter results to calls which have a `startTime` after or including
732
+
`minStartTime`(in ISO8601 format).
733
+
example: 2022-06-21T19:13:21Z
734
+
explode: true
735
+
in: query
736
+
name: minStartTime
737
+
required: false
738
+
schema:
739
+
type: string
740
+
style: form
741
+
- description: Filter results to calls which have a `startTime` before or including
742
+
`maxStartTime`(in ISO8601 format).
743
+
example: 2022-06-21T19:13:21Z
744
+
explode: true
745
+
in: query
746
+
name: maxStartTime
747
+
required: false
748
+
schema:
749
+
type: string
750
+
style: form
751
+
- description: Filter results to calls with specified call Disconnect Cause.
752
+
example: hangup
753
+
explode: true
754
+
in: query
755
+
name: disconnectCause
756
+
required: false
757
+
schema:
758
+
type: string
759
+
style: form
760
+
- description: Specifies the max number of calls that will be returned.
761
+
example: 500
762
+
explode: true
763
+
in: query
764
+
name: pageSize
765
+
required: false
766
+
schema:
767
+
default: 1000
768
+
format: int32
769
+
maximum: 10000
770
+
minimum: 1
771
+
type: integer
772
+
style: form
773
+
- description: "Not intended for explicit use. To use pagination, follow the\
774
+
\ links in the `Link` header of the response, as indicated in the endpoint\
0 commit comments