{"id":13613902,"url":"https://github.com/cisco-ce/jsxapi","last_synced_at":"2025-04-13T18:31:46.780Z","repository":{"id":28633592,"uuid":"118922199","full_name":"cisco-ce/jsxapi","owner":"cisco-ce","description":"JavaScript bindings for Cisco Collaboration Endpoint XAPI","archived":false,"fork":false,"pushed_at":"2023-07-31T10:12:37.000Z","size":3241,"stargazers_count":44,"open_issues_count":20,"forks_count":22,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-06T06:20:53.056Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://cisco-ce.github.io/jsxapi/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cisco-ce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-25T14:20:57.000Z","updated_at":"2025-04-05T14:04:59.000Z","dependencies_parsed_at":"2024-06-18T18:17:53.607Z","dependency_job_id":"9ef8dd08-a616-418c-ba14-0115e3af8261","html_url":"https://github.com/cisco-ce/jsxapi","commit_stats":{"total_commits":292,"total_committers":5,"mean_commits":58.4,"dds":"0.10616438356164382","last_synced_commit":"b5ed1cd949ff780565e760452ff75f674954ade1"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-ce%2Fjsxapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-ce%2Fjsxapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-ce%2Fjsxapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cisco-ce%2Fjsxapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cisco-ce","download_url":"https://codeload.github.com/cisco-ce/jsxapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248760406,"owners_count":21157352,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T20:00:54.667Z","updated_at":"2025-04-13T18:31:46.459Z","avatar_url":"https://github.com/cisco-ce.png","language":"TypeScript","funding_links":[],"categories":["Building Blocks"],"sub_categories":[],"readme":"# JSXAPI\n\n[![Build Status](https://travis-ci.com/cisco-ce/jsxapi.svg?branch=master)](https://app.travis-ci.com/github/cisco-ce/jsxapi)\n\n[API Documentation](https://cisco-ce.github.io/jsxapi/)\n\nA set of tools to integrate with the Cisco Telepresence Endpoint APIs in\nJavaScript.\n\n## Quick start examples\n\n### Connecting using WebSockets\n\n``` javascript\nconst jsxapi = require('jsxapi');\n\njsxapi\n  .connect('wss://host.example.com', {\n    username: 'admin',\n    password: 'password',\n  })\n  .on('error', console.error)\n  .on('ready', async (xapi) =\u003e {\n    const volume = await xapi.status.get('Audio Volume');\n    console.log(`volume is: ${volume}`);\n    xapi.close();\n  });\n```\n\n### Connecting using SSH\n\n``` javascript\nconst jsxapi = require('jsxapi');\n\njsxapi\n  .connect('ssh://host.example.com', {\n    username: 'admin',\n    password: 'password',\n  })\n  .on('error', console.error)\n  .on('ready', async (xapi) =\u003e {\n    const volume = await xapi.status.get('Audio Volume');\n    console.log(`volume is: ${volume}`);\n    xapi.close();\n  });\n```\n\n### New style API\n\nThe aim of the new style API is to improve readability, while also being more\nsuited towards automatic type generation and auto-completion.\n\n```javascript\n// Set up a call\nxapi.Command.Dial({ Number: 'user@example.com' });\n\n// Fetch volume and print it\nxapi.Status.Audio.Volume\n  .get()\n  .then((volume) =\u003e { console.log(volume); });\n\n// Set a configuration\nxapi.Config.SystemUnit.Name.set('My System');\n\n// Listen to feedback\nconst off = xapi.Event.Standby.on((event) =\u003e {\n  // ...\n});\n\n// De-register feedback\noff();\n```\n\n### Old style API\n\n```javascript\n// Set up a call\nxapi.command('Dial', { Number: 'user@example.com' });\n\n// Fetch volume and print it\nxapi.status\n  .get('Audio Volume')\n  .then((volume) =\u003e { console.log(volume); });\n\n// Set a configuration\nxapi.config.set('SystemUnit Name', 'My System');\n\n// Listen to feedback\nconst off = xapi.event.on('Standby', (event) =\u003e {\n  // ...\n});\n\n// De-register feedback\noff();\n```\n\n## Documentation\n\nThe full API documentation can be built by running `npm install` in a `jsxapi`\nmodule directory. Documentation will be located under `docs/` can then be opened\nin a browser.\n\nMore specifically:\n\n```\nmkdir tmp\ncd tmp\nnpm install jsxapi\ncd node_modules/jsxapi\nnpm install\n```\n\nThen open `./docs/index.html`.\n\n## Questions and support?\n\nFind more information regarding Cisco's Room Devices over at\n[developer.cisco.com](https://developer.cisco.com/site/roomdevices/) or the\n[TelePresence and Video](https://supportforums.cisco.com/t5/telepresence/bd-p/5886-discussions-telepresence)\nsupport forums.\n\nQuestions about the xAPI, integrations and customizations? Using\n[Webex Teams](https://www.webex.com/team-collaboration.html) join the xAPI Devs\nspace community for realtime support by [clicking this link](https://eurl.io/#rkp76XDrG)\nand entering your Webex Teams-registered e-mail address at the prompt.\n\n## Development \u0026 Contribution\n\n### Release procedure\n\nMaking a release is quite simple:\n\n * Perform all changes/commits.\n * Determine the version change (`npm help semver`).\n * Update \"CHANGELOG.md\" with version number, date and change summary.\n * Run `npm version` with the appropriate version bump.\n * Run `npm publish` to push the package version to the registry.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcisco-ce%2Fjsxapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcisco-ce%2Fjsxapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcisco-ce%2Fjsxapi/lists"}