Download the PHP package oriacall/sdk without Composer

On this page you can find all versions of the php package oriacall/sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package sdk

oriacall/sdk

PHP SDK for the Oriacall Developer API.

Install

Requirements:

Quickstart

The SDK requests and caches a short-lived access token using client credentials, then sends it as a bearer token for API calls.

Client Options

Options:

Option Type Required Description
clientId string Yes Developer API client ID.
clientSecret string Yes Developer API client secret. Keep this server-side.
baseUrl string No API base URL. Defaults to https://api.oriacall.com.
scope string|array|null No Space-separated string or array of requested token scopes. If omitted, the token request uses all scopes granted to the client.
onResponse callable|null No Called for every SDK-managed HTTP response, including token requests.
retries int No Retry count for token requests and GET endpoints. Defaults to 0.
retryBaseDelayMs int No Initial retry delay. Defaults to 250.
retryMaxDelayMs int No Maximum retry delay. Defaults to 2000.
timeoutSeconds int No cURL timeout. Defaults to 30.

Response Envelope

Every endpoint method returns Oriacall\ApiResponse:

Methods

$oriacall->calls->get('call-id') includes transcript data when available. Transcript turn speaker values can be agent, client, or system. system represents telephony infrastructure such as voicemail greetings, carrier messages, transfer prompts, or tones; it is not a human participant.

Call List Options

$oriacall->calls->list() and $oriacall->calls->paginate() accept these optional camelCase options:

Option Type Description
limit int Page size from 1 to 100.
cursor string Opaque cursor from pagination.nextCursor.
objectiveId string Filter by objective ID.
leadId string Filter by lead ID.
agentId string Filter by agent ID.
externalId string Filter by an exact external ID match.
createdAfter string Include calls created at or after this ISO 8601 timestamp.
createdBefore string Include calls created at or before this ISO 8601 timestamp.
recordedAfter string Include calls recorded at or after this ISO 8601 timestamp.
recordedBefore string Include calls recorded at or before this ISO 8601 timestamp.
sortBy createdAt\|recordedAt Select creation-time or recording-time order.
leadCustomFields array<string, mixed> Filter by lead custom fields.

Find one call by its exact external ID:

Look Up Calls By External IDs

Use $oriacall->calls->lookupByExternalIds() to resolve multiple external call IDs in one request:

Required scope: calls:read.

The $externalIds parameter must be a list of 1 to 100 distinct, non-empty strings, each at most 255 characters. Matching is exact and case-sensitive. The response contains every matching call summary without pagination; missing IDs do not produce placeholders, and duplicate external IDs assigned to multiple calls return every match.

Upload A Call

To upload in-memory audio, use contents instead of path:

Required scope: calls:write.

Update original source recording time for an existing call:

Required scope: calls:write.

objectiveId is optional. When provided, Oriacall associates the call with that organization objective. When omitted, Oriacall associates the call with an existing objective in the organization.

Call summaries include callResult, callResultLabel, and callQualityScore. analysisStatus is one of pending, queued, processing, completed, or failed. queueStatus is queued, processing, completed, failed, or null when analysis has not been queued. analysisStage is audio_pass, text_pass, publishing, completed, or null when analysis has not been queued. Internal dead-letter and cancelled runs are exposed as failed. Completed call analysis includes summary, callStrengths, callWeaknesses, callObservations, objections, and alerts.

Pagination

List endpoints use cursor pagination.

Pagination helpers are available for objectives, agents, calls, leads, and webhooks->endpoints.

Custom Field Filters

Use SDK option names that match the TypeScript SDK. The PHP SDK maps them to the public API query parameters:

For calls, createdAfter and createdBefore filter by Oriacall upload/record creation time. Use recordedAfter, recordedBefore, and sortBy => recordedAt for original call chronology. The recorded-time filters and sort fall back to createdAt when recordedAt is null.

Errors

Failed API calls throw Oriacall\ApiError:

Webhook Signature Verification

Scopes

Available scopes:

The token request can only request scopes that were granted to that API client.


All versions of sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package oriacall/sdk contains the following files

Loading the files please wait ...